Skip to contents

Partition OSRM Graph for Multi-Level Dijkstra (MLD)

Source: R/osrm_partition.R
osrm_partition.Rd

Run the osrm-partition tool to partition an OSRM graph for the MLD pipeline. After running, a companion <base>.osrm.partition file must exist to confirm success.

Usage

osrm_partition(
  input_osrm,
  threads = 8L,
  verbosity = c("INFO", "NONE", "ERROR", "WARNING", "DEBUG"),
  balance = 1.2,
  boundary = 0.25,
  optimizing_cuts = 10L,
  small_component_size = 1000L,
  max_cell_sizes = c(128, 4096, 65536, 2097152),
  quiet = FALSE,
  verbose = FALSE,
  spinner = TRUE,
  echo_cmd = FALSE
)

Arguments

input_osrm

A string. Path to a .osrm.timestamp file, the base path to the .osrm files (without extension), or a directory containing exactly one .osrm.timestamp file.

threads

An integer. Number of threads to use; default 8 (osrm-partition's default).

verbosity

A string. Log verbosity level passed to -l/--verbosity (one of "NONE","ERROR","WARNING","INFO","DEBUG"); default "INFO".

balance

A numeric. Balance for left and right side in single bisection; default 1.2.

boundary

A numeric. Percentage of embedded nodes to contract as sources and sinks; default 0.25.

optimizing_cuts

An integer. Number of cuts to use for optimizing a single bisection; default 10.

small_component_size

An integer. Size threshold for small components; default 1000.

max_cell_sizes

A numeric vector. Maximum cell sizes starting from level 1; default c(128,4096,65536,2097152).

quiet

A logical. Master switch that suppresses package messages and process output when TRUE; default FALSE.

verbose

A logical. When TRUE and quiet = FALSE, streams stdout and stderr from the underlying processx::run calls.

spinner

A logical. When TRUE and quiet = FALSE, shows a spinner instead of live logs; default TRUE.

echo_cmd

A logical. When TRUE and quiet = FALSE, prints each command before running; default FALSE.

Value

An object of class osrm_job with the following elements:

osrm_job_artifact

The path to the partitioned .osrm.partition file.

osrm_working_dir

The directory containing all OSRM files.

logs

The processx::run result object.

Examples

# \donttest{
if (identical(Sys.getenv("OSRM_EXAMPLES"), "true")) {
  install_dir <- osrm_install(
    version = "latest",
    path_action = "session",
    quiet = TRUE
  )

  # Prepare a small graph then partition it for the MLD pipeline
  pbf_path <- system.file("extdata/cur.osm.pbf", package = "osrm.backend")
  osrm_dir <- file.path(tempdir(), paste0("osrm-", Sys.getpid()))
  dir.create(osrm_dir, recursive = TRUE)
  tmp_pbf <- file.path(osrm_dir, "cur.osm.pbf")
  file.copy(from = pbf_path, to = tmp_pbf, overwrite = TRUE)
  profile <- osrm_find_profile("car.lua")

  extract_job <- osrm_extract(
    input_osm = tmp_pbf,
    profile = profile,
    overwrite = TRUE,
    threads = 1L
  )

  partition_job <- osrm_partition(extract_job, threads = 1L, verbose = TRUE)
  partition_job$osrm_job_artifact

  osrm_uninstall(
    dest_dir = install_dir,
    clear_path = TRUE,
    force = TRUE,
    quiet = TRUE
  )
  unlink(osrm_dir, recursive = TRUE)
}
# }