-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.Rmd
91 lines (63 loc) · 4.24 KB
/
README.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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
## acton
<!-- badges: start -->
[](https://github.com/cyipt/acton/actions)
<!-- badges: end -->
## Introduction
**ACTON** is a research project for assessing active transport options for new developments to inform development decisions.
The aim is to provide an open, consistent and scalable evidence base for local authorities, housing developers and civil society groups to support planning and investment that enables the walking and cycling revolution that is needed to tackle health and environmental issues.
To make the results of the research more reproducible and accessible to others, it is also an R package.
In first place, ACTON is about evidence-based planning and that means it is about data.
ACTON provides easy access to actionable data from 4 main sources, each of which is already in the public domain, which had never before been made available in a single place or analysed together to support planning, as illustrated in the schematic diagram below.
```{r workflow, echo=FALSE}
nomnoml::nomnoml("
#direction: down
#.box: fill=#8f8 visual=ellipse
[PlanIt]-[<box>ACTON]
[Accessibility]-[ACTON]
[Travel/Demographics]-[ACTON]
[Route]-[ACTON]
")
```
The four main data sources shown above are:
- PlanIt data on new developments based on planning documents submitted to local government planning departments
- Accessibility data, including travel times by mode for different trip purposes, e.g. the average time taken to cycle to the shops, for small administrative zones (MSOA and LSOA level)
- Trave/demographic data from surveys (the 2011 Census in the first instance), providing information about the number of people in different groups in administrative zones and likely work destinations at the origin-destination level (plus data derived from the Census via the Propensity to Cycle Tool project)
- Route data from routing services such as CycleStreets.net, providing information on the transport networks surrounding new development sites, with variables such as busyness and speed limits along roads nearby new and planned development sites
ACTON seeks to make these datasets more widely accessible and actionable by combining them and using them to assess walking and cycling provision in and around new developments, to inform policies and investment
For more information about the research project, see the [ACTON report](https://cyipt.github.io/acton/articles/the-acton-project.html) (PDF version available [here](https://github.com/cyipt/acton/files/4482361/the-acton-project.pdf)) and [case study](https://cyipt.github.io/acton/articles/case-studies.html) articles.
## Installing the R package
To install the `acton` package, run the following commands in an R console (see [here](https://docs.ropensci.org/stats19/articles/stats19-training-setup.html) for information on installing R):
```{r, eval=FALSE}
install.packages("remotes")
remotes::install_github("cyipt/acton", dependencies = "Suggests")
```
## Setup instructions
To get routes from CycleStreets.net, you will need to set-up an API key called CYCLESTREETS with `usethis::edit_r_environ()`, as documented here: https://docs.ropensci.org/stplanr/reference/route_cyclestreets.html#details
## Brief demo
The package can be used to get data on new developments as follows:
```{r}
library(acton)
# data from specific postcode
planning_data = get_planit_data(pcode = "LS2 9JT", limit = 2, app_size = "large")
planning_data
planning_data$name
planning_data$description
```
## Documentation
For a more detailed overview explaining how to use the package see the [`acton` vignette](https://cyipt.github.io/acton/articles/acton.html).
For results of research into active travel opportunities in and around new developments in case study regions, see the [`case-studies` vignette](https://cyipt.github.io/acton/articles/case-studies.html).
For documentation on each of the package's functions, see the [Reference page](https://cyipt.github.io/acton/reference/index.html).
## Citing the work
TBC.