Repository files navigation

openrouteservice R package provides easy access to theopenrouteservice (ORS) API from R. Itallows you to painlessly consume the following services:

• directions(routing)
• geocodingpowered byPelias
• isochrones(accessibility)
• time-distancematrices
• snappingto OpenStreetMap ways
• exportingthe underlying routing graph structure
• pois(points of interest)
• SRTMelevationfor point and lines geometries
• routingoptimizationbased onVroom

By using this package, you agree to the ORSterms andconditions.

The latest release version can be readily obtained from CRAN via a callto

install.packages("openrouteservice")

For running the current development version from GitHub it isrecommended to usepak, as ithandles the installation of all the necessary packages and their systemdependencies automatically.

# install.packages("pak")pak::pak("GIScience/openrouteservice-r")

See the packagevignettefor an overview of the offered functionality.

The default is to fire any requests against the free public services at<api.openrouteservice.org>. In order to query a differentopenrouteservice instance, say a local one, set

options(openrouteservice.url = "http://localhost:8082/ors")

If necessary, endpoint configuration can be further customized throughopenrouteservice.paths which specifies a named list of paths. Thedefaults are equivalent of having

options(openrouteservice.paths = list(directions = "v2/directions",                                      isochrones = "v2/isochrones",                                      matrix = "v2/matrix",                                      geocode = "geocode",                                      pois = "pois",                                      elevation = "elevation",                                      optimization = "optimization",                                      snap = "v2/snap",                                      export = "v2/export"))

• Enable export endpoint.

• sf output for snapping.

• sf output for POIs endpoint (#81)

• Enable snap endpoint.

Please feel free to reach out if you would like to have your work addedto the list below.

1. Baumer BS, Kaplan DT, Horton NJ. Modern data science with r.Chapman; Hall/CRC; 2017.

2. Cervigni E, Renton M, McKenzie FH, Hickling S, Olaru D. Describingand mapping diversity and accessibility of the urban foodenvironment with open data and tools. Applied Geography.2020;125:102352.

3. Petricola S, Reinmuth M, Lautenbach S, Hatfield C, Zipf A. Assessingroad criticality and loss of healthcare accessibility during floods:The case of cyclone idai, mozambique 2019. International journal ofhealth geographics. 2022;21(1):14.

4. Weenink P. Overcoming the modifiable areal unit problem (MAUP) ofsocio-economic variables in real estate modellingPhDthesis. 2022.

5. Shields N, Willis C, Imms C, McKenzie G, Van Dorsselaer B, BruderAM, et al. Feasibility of scaling-up a community-based exerciseprogram for young people with disability. Disability andRehabilitation. 2022;44(9):1669–81.

6. Veloso R, Cespedes J, Caunhye A, Alem D. Brazilian disaster datasetsand real-world instances for optimization and machine learning. Datain brief. 2022;42:108012.

7. Cubells J, Miralles-Guasch C, Marquet O. E-scooter and bike-shareroute choice and detours: Modelling the influence of builtenvironment and sociodemographic factors. Journal of transportgeography. 2023;111:103664.

8. Bhowon Y, Prendergast LA, Taylor NF, Shields N. Using geospatialanalysis to determine the proximity of community gyms for apopulation-based cohort of young people with cerebral palsy.Physiotherapy Canada. 2023;e20220064.

9. Amato S, Benson JS, Stewart B, Sarathy A, Osler T, Hosmer D, etal. Current patterns of trauma center proliferation have not led toproportionate improvements in access to care or mortality afterinjury: An ecologic study. Journal of Trauma and Acute Care Surgery.2023;94(6):755–64.

10. Jain A, LaValley M, Dukes K, Lane K, Winter M, Spangler KR, etal. Modeling health and well-being measures using ZIP code spatialneighborhood patterns. Scientific Reports. 2024;14(1):9180.