Skip to contents

Quick Start

Automate installation, graph preparation, and server launch.

osrm_start()
Start an OSRM Server with Automatic Setup
osrm_stop()
Stop an OSRM Server

Install and update OSRM binaries

Discover, install, or remove OSRM backend releases and keep your PATH tidy.

osrm_install()
Install OSRM Backend Binaries
osrm_uninstall()
Uninstall OSRM Backend Binaries
osrm_which()
Locate the OSRM Installation Used by osrm.backend
osrm_clear_path()
Clear OSRM Path from Project's .Rprofile
osrm_check_latest_version()
Check for the Latest Stable OSRM Version
osrm_check_available_versions()
Check for Available OSRM Versions

Build routing graphs

Prepare OSRM graphs from raw OSM extracts or run specific pipeline stages when you need finer control.

osrm_prepare_graph()
Prepare OSRM Graph for Routing (Extract + Partition/Contract)
osrm_extract()
Extract OSM into OSRM Graph Files
osrm_partition()
Partition OSRM Graph for Multi-Level Dijkstra (MLD)
osrm_customize()
Customize OSRM Graph for Multi-Level Dijkstra (MLD)
osrm_contract()
Contract OSRM Graph for Contraction Hierarchies (CH)
osrm_find_profile()
Locate an OSRM Lua profile (e.g. car.lua) in a host installation

Run and monitor servers

Launch osrm-routed manually, inspect registered processes, and stop them cleanly.

osrm_start_server()
Start an OSRM MLD/CH server with osrm-routed
osrm_servers()
List OSRM servers started via this package
osrm_stop()
Stop an OSRM Server
osrm_stop_all()
Stop all running OSRM servers started via this package