otp_make_surface: Make a Surface

In ropensci/opentripplanner: Setup and connect to 'OpenTripPlanner'

Make a Surface

Description

Requires OTP 1.x and the analyst

Usage

otp_make_surface(
  otpcon = NULL,
  fromPlace = c(-1.17502, 50.6459),
  mode = "CAR",
  date_time = Sys.time(),
  maxWalkDistance = 1000,
  arriveBy = FALSE,
  routeOptions = NULL,
  timezone = otpcon$timezone,
  ncores = 1
)

Arguments

otpcon	OTP connection object produced by otp_connect()
fromPlace	Numeric vector, Longitude/Latitude pair, e.g. 'c(-0.134649,51.529258)', or 2 column matrix of Longitude/Latitude pairs, or sf data frame of POINTS with CRS 4326
mode	character vector of one or more modes of travel valid values TRANSIT, WALK, BICYCLE, CAR, BUS, RAIL, SUBWAY, TRAM, FERRY, default CAR. Not all combinations are valid e.g. c("WALK","BUS") is valid but c("WALK","CAR") is not.
date_time	POSIXct, a date and time, defaults to current date and time
maxWalkDistance	Numeric passed to OTP in metres
arriveBy	Logical, Whether the trip should depart or arrive at the specified date and time, default FALSE
routeOptions	Named list of values passed to OTP use
timezone	Character, what timezone to use, see as.POSIXct, default is local timezone
ncores	How many cores to use default = 1

Details

THis function requires the analysis and pointset features to be enabled during 'otp_setup()'. Thus it will only work with OTP 1.x. For more detail see the analyst vignette.

Value

Returns a list with information about the surface created

See Also

Other analyst: otp_traveltime()

Examples

## Not run: 
surface <- otp_make_surface(otpcon, c(-1.17502, 50.64590))

## End(Not run)

ropensci/opentripplanner documentation built on Aug. 5, 2024, 9:58 p.m.