In cyclestreets/cyclestreets-r: Cycle Routing and Data for Cycling Advocacy

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

cyclestreets

The goal of cyclestreets is to provide a simple R interface to the CycleStreets routing service.

It was split-out from stplanr for modularity.

Installation

You can install the released version of cyclestreets from CRAN with:

install.packages("cyclestreets")

Install the development version with devtools as follows:

# install.packages("devtools")
devtools::install_github("cyclestreets/cyclestreets-r")

Example

A common need is to get from A to B:

library ("cyclestreets")
# stplanr::geo_code ("leeds rail station") 
from = c(-1.544, 53.794)
# stplanr::geo_code ("leeds university") 
to = c(-1.551, 53.807)
r = cyclestreets::journey(from, to, "balanced")
sf:::plot.sf(r)

To get a key go to https://www.cyclestreets.net/api/apply/

Save the key as an environment varible using export CYCLESTREETS=your_key_here by adding CYCLESTREETS=your_key_here as a new line in your .Renviron file, e.g. with the following command:

usethis::edit_r_environ()

Check the map is good with leaflet:

library(leaflet)
p = colorNumeric("RdYlBu", domain = r$quietness, reverse = TRUE)
leaflet(r) %>% 
  addTiles() %>% 
  addPolylines(color = ~p(quietness), weight = 20, opacity = 0.9) %>% 
  addLegend(pal = p, values = ~quietness)

Or tmap, highlighting the recently added 'quietness' variable:

library(tmap)
tmap_mode("view")
tm_shape(r) + tm_lines("quietness", palette = "RdYlBu", lwd = 3)

library(tmap)
tmap_mode("view")
m = tm_shape(r) + tm_lines("quietness", palette = "RdYlBu", lwd = 3)
tmap_save(m, "m.html")
webshot2::webshot("m.html")

See an interactive version of this map, showing all variables per segment, here.

Or mapview:

mapview::mapview(r)

Route types available are: fastest, quietest, balanced. See help pages such as ?journey and https://www.cyclestreets.net/api/ for details.

You can also get streets by LTN status.

network_ltns = ltns(r)
plot(network_ltns)

cyclestreets/cyclestreets-r documentation built on Dec. 9, 2024, 7:02 p.m.