-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathindex.Rmd
57 lines (41 loc) · 2.76 KB
/
index.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
---
output:
github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
# PALMSplus for R
<!--[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/TheTS/palmsplusr?branch=master&svg=true)](https://ci.appveyor.com/project/TheTS/palmsplusr)-->
<!--[![Travis-CI Build Status](https://travis-ci.org/TheTS/palmsplusr.svg?branch=master)](https://travis-ci.org/TheTS/palmsplusr) -->
<!--[![codecov](https://codecov.io/gh/TheTS/actigraph.sleepr/branch/master/graph/badge.svg)](https://codecov.io/gh/TheTS/actigraph.sleepr)-->
[![Project Status](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
[![Version](https://img.shields.io/badge/Package%20version-0.1.0-green.svg)](commits/master)
[![Last Change](https://img.shields.io/badge/Last%20change-`r gsub('-', '--', Sys.Date())`-yellowgreen.svg)](/commits/master)
## Overview
**palmsplusr** is an extension to the *Personal Activity Location Measurement System* ([PALMS](https://ucsd-palms-project.wikispaces.com/)). This R package provides a customisable platform to combine PALMS data with other sources of information (e.g., shapefiles or csv files). This enables physical activity researchers to answer higher-level questions, such as:
* How much time is spent in parks?
* How much MVPA is accumulated in parks?
* What proportion of sedentary time is accumulated during vehicular travel?
* What is the average distance of home-to-school trips?
* How much MVPA is accumulated inside the schoolyard during school time?
* What proportion of commuters trip chain different travel modes (e.g., walk-bus-walk)
* What is the average speed of bicycle trips during peak travel times?
The PALMS data are combined with other input files to build the palmsplus [simple features](https://github.com/r-spatial/sf) data frame. This can then be summarised two ways:
1. `days` provides a breakdown of information per day, per person (e.g., time spent in greenspace)
2. `trajectories` builds individual trips, and provides trip-level summaries (e.g., MVPA during the work commute). This can then be processed into multimodal trips if desired.
The user is able to specify how each data source is combined. This is done by creating `field` tables using highly customisable formulas.
![Palms Workflow](http://i.imgur.com/aSzlC3E.png)
## Installation
The easiest way to install **palmsplusr** is using devtools:
```{r, eval = FALSE}
library("devtools")
install_github("TheTS/palmsplusr")
```
### Notes
This project is based on the [palmsplus](https://github.com/bsnizek/palmsplus) project originally written in PostgreSQL and PostGIS by [Bernhard Snizek](http://www.snizek.com).