hereR (version 0.3.2)

route_matrix: HERE Routing API: Calculate Matrix

Description

Calculates a matrix of M:N, M:1 or 1:N route summaries between given points of interest (POIs) using the HERE 'Routing' API. Various transport modes and traffic information at a provided timestamp are supported. The requested matrix is split into (sub-)matrices of dimension 15x100 to use the maximum matrix size per request and thereby minimize the number of overall needed requests. The result is one route summary matrix, that fits the order of the provided POIs: origIndex, destIndex.

Usage

route_matrix(
  origin,
  destination = origin,
  datetime = Sys.time(),
  type = "fastest",
  mode = "car",
  traffic = FALSE,
  search_range = 99999999,
  attribute = c("distance", "traveltime"),
  url_only = FALSE
)

Arguments

origin

sf object, the origin locations (M) of geometry type POINT.

destination

sf object, the destination locations (N) of geometry type POINT.

datetime

POSIXct object, datetime for the departure.

type

character, set the routing type: "fastest", "shortest" or "balanced".

mode

character, set the transport mode: "car", "pedestrian", "carHOV" or "truck".

traffic

boolean, use real-time traffic or prediction in routing (default = FALSE)? If no datetime is set, the current timestamp at the moment of the request is used for datetime.

search_range

numeric, value in meters to limit the search radius in the route generation (default = 99999999).

attribute

character, attributes to be calculated on the routes: "distance" or "traveltime" (default = c("distance", "traveltime").

url_only

boolean, only return the generated URLs (default = FALSE)?

Value

A data.frame, which is an edge list containing the requested M:N route combinations.

References

HERE Routing API: Calculate Matrix

Examples

# NOT RUN {
# Provide an API Key for a HERE project
set_key("<YOUR API KEY>")

# Create routes summaries between all POIs
mat <- route_matrix(
  origin = poi,
  traffic = TRUE,
  url_only = TRUE
)
# }