stplanr (version 0.4.0)

route: Plan routes on the transport network

Description

Takes origins and destinations, finds the optimal routes between them and returns the result as a spatial (sf or sp) object. The definition of optimal depends on the routing function used

Usage

route(from = NULL, to = NULL, l = NULL,
  route_fun = stplanr::route_cyclestreet, n_print = 10,
  list_output = FALSE, ...)

Arguments

from

An object representing origins (if lines are provided as the first argument, from is assigned to l)

to

An object representing destinations

l

Only needed if from and to are empty, in which case this should be a spatial object representing desire lines

route_fun

A routing function to be used for converting the straight lines to routes od2line()

n_print

A number specifying how frequently progress updates should be shown

list_output

If FALSE (default) assumes spatial (linestring) object output. Set to TRUE to save output as a list.

...

Arguments passed to the routing function, e.g. route_cyclestreet()

See Also

Other routes: line2routeRetry, line2route, nearest2spdf, route_cyclestreet, route_dodgr, route_graphhopper, route_local, route_osrm, route_transportapi_public, viaroute2sldf, viaroute

Examples

# NOT RUN {
# requires CycleStreets.net API key
from <- c(-1.5327, 53.8006) # from <- geo_code("leeds rail station")
to <- c(-1.5279, 53.8044) # to <- geo_code("university of leeds")
route_leek_to_hereford <- route(from, to)
route(cents_sf[1:3, ], cents_sf[2:4, ]) # sf points
route(flowlines_sf[2:4, ]) # lines
# }