knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

acton

R-CMD-check

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.

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:

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 (PDF version available here) and case study articles.

Installing the R package

To install the acton package, run the following commands in an R console (see here for information on installing R):

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:

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.

For results of research into active travel opportunities in and around new developments in case study regions, see the case-studies vignette.

For documentation on each of the package's functions, see the Reference page.

Citing the work

TBC.



cyipt/acton documentation built on Jan. 29, 2021, 7:30 a.m.