r5r is an R package for rapid realistic routing on multimodal transport networks (walk, bike, public transport and car) using R5. The package allows users to generate detailed routing analysis or calculate travel time matrices using seamless parallel computing on top of the R5 Java machine https://github.com/conveyal/r5

1. Introduction

r5r is an R package for rapid realistic routing on multimodal transport networks (walk, bike, public transport and car). It provides a simple and friendly interface to R5, a really fast and open source Java-based routing engine developed separately by Conveyal. R5 stands for Rapid Realistic Routing on Real-world and Reimagined networks. More details about r5r can be found on the package webpage or on this paper.

2. Installation

You can install r5r from CRAN, or the development version from github.


# github
devtools::install_github("ipeaGIT/r5r", subdir = "r-package")

Please bear in mind that you need to have Java SE Development Kit 11 installed on your computer to use r5r. No worries, you don’t have to pay for it. The jdk 11 is freely available from the options below:

If you don’t know what version of Java you have installed on your computer, you can check it by running this on R console.

  rJava::.jcall("java.lang.System", "S", "getProperty", "java.version")

3. Usage

Before we start, we need to increase the memory available to Java. This is necessary because, by default, R allocates only 512MB of memory for Java processes, which is not enough for large queries using r5r. To increase available memory to 2GB, for example, we need to set the java.parameters option at the beginning of the script, as follows:

options(java.parameters = "-Xmx2G")

Note: It’s very important to allocate enough memory before loading r5r or any other Java-based package, since rJava starts a Java Virtual Machine only once for each R session. It might be useful to restart your R session and execute the code above right after, if you notice that you haven’t succeeded in your previous attempts.

Then we can load the packages used in this vignette:

The r5r package has five fundamental functions:

  1. setup_r5() to initialize an instance of r5r, that also builds a routable transport network;

  2. accessibility() for fast computation of access to opportunities considering a selected decay function;

  3. travel_time_matrix() for fast computation of travel time estimates between origin/destination pairs;

  4. expanded_travel_time_matrix() for calculating travel matrices between origin destination pairs with additional information such routes used and total time disaggregated by access, waiting, in-vehicle and transfer times.

  5. detailed_itineraries() to get detailed information on one or multiple alternative routes between origin/destination pairs.

Most of these functions also allow users to account for monetary travel costs when generating travel time matrices and accessibility estimates. More info about how to consider monetary costs can be found in this vignette.

3.1 Data requirements:

To use r5r, you will need: - A road network data set from OpenStreetMap in .pbf format (mandatory) - A public transport feed in GTFS.zip format (optional) - A raster file of Digital Elevation Model data in .tif format (optional)

Here are a few places from where you can download these data sets:

Let’s have a quick look at how r5r works using a sample data set.

4. Demonstration on sample data


To illustrate the functionalities of r5r, the package includes a small sample data for the city of Porto Alegre (Brazil). It includes seven files:

  • An OpenStreetMap network: poa_osm.pbf
  • Two public transport feeds: poa_eptc.zip and poa_trensurb.zip
  • A raster elevation data: poa_elevation.tif
  • A poa_hexgrid.csv file with spatial coordinates of a regular hexagonal grid covering the sample area, which can be used as origin/destination pairs in a travel time matrix calculation.
  • A poa_points_of_interest.csv file containing the names and spatial coordinates of 15 places within Porto Alegre
  • A fares_poa.zip file with the fare rules of the city’s public transport system.
data_path <- system.file("extdata/poa", package = "r5r")
#> [1] "fares"                      "poa_hexgrid.csv"           
#> [3] "poa_osm.pbf"                "poa_points_of_interest.csv"

The points of interest data can be seen below. In this example, we will be looking at transport alternatives between some of those places.

poi <- fread(file.path(data_path, "poa_points_of_interest.csv"))
#>                     id       lat       lon
#> 1:       public_market -30.02756 -51.22781
#> 2: bus_central_station -30.02329 -51.21886
#> 3:    gasometer_museum -30.03404 -51.24095
#> 4: santa_casa_hospital -30.03043 -51.22240
#> 5:            townhall -30.02800 -51.22865
#> 6:     piratini_palace -30.03363 -51.23068

The data with origin destination pairs is shown below. In this example, we will be using 200 points randomly selected from this data set.

points <- fread(file.path(data_path, "poa_hexgrid.csv"))

# sample points
sampled_rows <-  sample(1:nrow(points), 200, replace=TRUE)
points <- points[ sampled_rows, ]
#>      V1              id       lon       lat population schools jobs healthcare
#> 1: 1007 89a901286cfffff -51.16863 -30.08486        271       0    0          0
#> 2: 1207 89a9012a10fffff -51.23932 -30.10239       1100       0   21          0
#> 3: 1118 89a9012ae2fffff -51.24437 -30.07701         31       0   30          1
#> 4:  211 89a90e924d3ffff -51.20817 -30.00936         75       0  423          0
#> 5:  316 89a9012a1abffff -51.24550 -30.10463       1644       0   51          1
#> 6:  910 89a9012864fffff -51.16532 -30.07821       1663       0    4          0

4.1 Building routable transport network with setup_r5()

The first step is to build the multimodal transport network used for routing in R5. This is done with the setup_r5 function. This function does two things: (1) downloads/updates a compiled JAR file of R5 and stores it locally in the r5r package directory for future use; and (2) combines the osm.pbf and gtfs.zip data sets to build a routable network object.

# Indicate the path where OSM and GTFS data are stored
r5r_core <- setup_r5(data_path = data_path)

4.2 Accessibility analysis

The faster way to calculate accessibility estimates is using the accessibility() function. In this example, we calculate the number of schools and health care facilities accessible in less than 60 minutes by public transport and walking. More details in this vignette on Calculating and visualizing Accessibility.

# set departure datetime input
departure_datetime <- as.POSIXct("13-05-2019 14:00:00",
                                 format = "%d-%m-%Y %H:%M:%S")

# calculate accessibility
access <- accessibility(r5r_core = r5r_core,
                        origins = points,
                        destinations = points,
                        opportunities_colnames = c("schools", "healthcare"),
                        mode = c("WALK", "TRANSIT"),
                        departure_datetime = departure_datetime,
                        decay_function = "step",
                        cutoffs = 60

4.3 Routing analysis

For fast routing analysis, r5r currently has three core functions: travel_time_matrix(), expanded_travel_time_matrix() and detailed_itineraries().

Fast many to many travel time matrix

The travel_time_matrix() function is a really simple and fast function to compute travel time estimates between one or multiple origin/destination pairs. The origin/destination input can be either a spatial sf POINT object, or a data.frame containing the columns id, lon, lat. The function also receives as inputs the max walking distance, in meters, and the max trip duration, in minutes. Resulting travel times are also output in minutes.

This function also allows users to very efficiently capture the travel time uncertainties inside a given time window considering multiple departure times. More info on this vignette.

# set inputs
mode <- c("WALK", "TRANSIT")
max_walk_time <- 30 # minutes
max_trip_duration <- 120 # minutes
departure_datetime <- as.POSIXct("13-05-2019 14:00:00",
                                 format = "%d-%m-%Y %H:%M:%S")

# calculate a travel time matrix
ttm <- travel_time_matrix(r5r_core = r5r_core,
                          origins = poi,
                          destinations = poi,
                          mode = mode,
                          departure_datetime = departure_datetime,
                          max_walk_time = max_walk_time,
                          max_trip_duration = max_trip_duration)


Expanded travel time matrix with minute-by-minute estimates

For those interested in more detailed outputs, the expanded_travel_time_matrix() works very similarly with travel_time_matrix() but it brings much more information. It estimates for each origin destination pair the routes used and total time disaggregated by access, waiting, in-vehicle and transfer times. Please note this function can be very memory intensive for large data sets.

# calculate a travel time matrix
ettm <- expanded_travel_time_matrix(r5r_core = r5r_core,
                          origins = poi,
                          destinations = poi,
                          mode = mode,
                          departure_datetime = departure_datetime,
                          breakdown = TRUE,
                          max_walk_time = max_walk_time,
                          max_trip_duration = max_trip_duration)


Detailed itineraries

Most routing packages only return the fastest route. A key advantage of the detailed_itineraries() function is that is allows for fast routing analysis while providing multiple alternative routes between origin destination pairs. The output also brings detailed information for each route alternative at the trip segment level, including the transport mode, waiting times, travel time and distance of each trip segment.

In this example below, we want to know some alternative routes between one origin/destination pair only.

# set inputs
origins <- poi[10,]
destinations <- poi[12,]
mode <- c("WALK", "TRANSIT")
max_walk_time <- 60 # minutes
departure_datetime <- as.POSIXct("13-05-2019 14:00:00",
                                 format = "%d-%m-%Y %H:%M:%S")

# calculate detailed itineraries
det <- detailed_itineraries(r5r_core = r5r_core,
                            origins = origins,
                            destinations = destinations,
                            mode = mode,
                            departure_datetime = departure_datetime,
                            max_walk_time = max_walk_time,
                            shortest_path = FALSE)


The output is a data.frame sf object, so we can easily visualize the results.

Visualize results

Static visualization with ggplot2 package: To provide a geographic context for the visualization of the results in ggplot2, you can also use the street_network_to_sf() function to extract the OSM street network used in the routing.

# extract OSM network
street_net <- street_network_to_sf(r5r_core)

# extract public transport network
transit_net <- transit_network_to_sf(r5r_core)

# plot
ggplot() +
  geom_sf(data = street_net$edges, color='gray85') +
  geom_sf(data = det, aes(color=mode)) +
  facet_wrap(.~option) + 

Cleaning up after usage

r5r objects are still allocated to any amount of memory previously set after they are done with their calculations. In order to remove an existing r5r object and reallocate the memory it had been using, we use the stop_r5 function followed by a call to Java’s garbage collector, as follows:

rJava::.jgc(R.gc = TRUE)

If you have any suggestions or want to report an error, please visit the package GitHub page.