osrm (version 3.2.0)

osrmRoute: Get the Shortest Path Between Two Points

Description

Build and send an OSRM API query to get the travel geometry between two points. This function interfaces the route OSRM service.

Usage

osrmRoute(src, dst, overview = "simplified", exclude = NULL,
  sp = FALSE)

Arguments

src

a numeric vector of identifier, longitude and latitude (WGS84), a SpatialPointsDataFrame or a SpatialPolygonsDataFrame of the origine point.

dst

a numeric vector of identifier, longitude and latitude (WGS84), a SpatialPointsDataFrame or a SpatialPolygonsDataFrame of the destination point.

overview

"full", "simplified" or FALSE. Add geometry either full (detailed), simplified according to highest zoom level it could be display on, or not at all.

exclude

pass an optional "exclude" request option to the OSRM API.

sp

if sp is TRUE the function returns a SpatialLinesDataFrame.

Value

If sp is FALSE, a data frame is returned. It contains the longitudes and latitudes of the travel path between the two points. If sp is TRUE a SpatialLinesDataFrame is returned. It contains 4 fields : identifiers of origine and destination, travel time in minutes and travel distance in kilometers. If overview is FALSE, a named numeric vector is returned. It contains travel time (in minutes) and travel distance (in kilometers).

Examples

# NOT RUN {
# Load data
data("berlin")

# Travel path between points
route <- osrmRoute(src = apotheke.df[1, c("id", "lon","lat")],
                   dst = apotheke.df[16, c("id", "lon","lat")])
# Travel path between points excluding motorways
route2 <- osrmRoute(src = apotheke.df[1, c("id", "lon","lat")],
                    dst = apotheke.df[16, c("id", "lon","lat")], 
                    exclude = "motorway")
# Display paths
plot(route[,1:2], type = "l", lty = 2, asp =1)
points(route2[,1:2], type = "l", lty = 2, asp = 1, col = "red")
points(apotheke.df[c(1,16),2:3], col = "red", pch = 20, cex = 1.5)
text(apotheke.df[c(1,16),2:3], labels = c("A","B"), pos = c(1, 2))


# Travel path between points between points - output a SpatialLinesDataFrame
route3 <- osrmRoute(src = c("A", 13.43853, 52.47728),
                    dst = c("B", 13.32247, 52.48882),
                    sp = TRUE, overview = "full")
# Travel path between points between points - output a SpatialLinesDataFrame 
# excluding motorways
route4 <- osrmRoute(src = c("A", 13.43853, 52.47728),
                    dst = c("B", 13.32247, 52.48882),
                    sp = TRUE, overview = "full", exclude = "motorway")
# Display the path
library(sp)
plot(route3, lty = 2, asp = 1)
plot(route4, lty = 2, asp = 1, col = "red", add = T)
points(x = c(13.43853,13.32247 ), y = c(52.47728, 52.48882), 
       col = "red", pch = 20, cex = 1.5)
text(x = c(13.43853,13.32247 ), y = c(52.47728, 52.48882), 
     labels = c("A","B"), pos = c(1, 2))


# Input is SpatialPointsDataFrames
route5 <- osrmRoute(src = apotheke.sp[1,], dst = apotheke.sp[2,], sp = TRUE)
route5@data
# }