Description

The goal of OpenTripPlanner for R is to provide a simple R interfaceto OpenTripPlanner (OTP).The OTP is a multimodal trip planning service.

Author(s)

Maintainer: Malcolm Morgan[email protected] (ORCID)

Authors:

• Marcus Young[email protected] (ORCID)

• Robin Lovelace[email protected] (ORCID)

Other contributors:

• Layik Hama[email protected] (ORCID) [contributor]

See Also

Useful links:

• https://github.com/ropensci/opentripplanner

• https://docs.ropensci.org/opentripplanner/

• Report bugs athttps://github.com/ropensci/opentripplanner/issues

Description

Example JSON response from OTPThis is used for internal testing and has no use

Usage

json_example_drive

Format

json

Description

Example JSON response from OTPThis is used for internal testing and has no use

Usage

json_example_long_drive

Format

json

Description

Example JSON response from OTPThis is used for internal testing and has no use

Usage

json_example_transit

Format

json

Description

OTP is run in Java and requires Java commands to be typed intothe command line. The function allows the parameters to be defined in R andautomatically passed to Java. This function builds a OTP graph from theOpen Street Map and other files.

Usage

otp_build_graph(  otp=NULL,  dir=NULL,  memory=2048,  router="default",  flag64bit=TRUE,  quiet=TRUE,  otp_version=NULL)

Arguments

Details

The OTP .jar file can be downloaded fromhttps://repo1.maven.org/maven2/org/opentripplanner/otp/

To build an OTP graph requires the following files to be in the directoryspecified by the dir variable.

/graphs - A sub-directory

/default - A sub-directory with the name of the OTP router used in router'variable

osm.pbf - Required, pbf file containing the Open Street Map

router-config.json - Required, json file containing configurations settingsfor the OTP

gtfs.zip - Optional, and number of GTFS files with transit timetables

terrain.tif - Optional, GeoTiff image of terrain map

The function will accept any file name for the .jar file, but it must bethe only .jar file in that directory OTP can support multiple routers (e.g.different regions), each router must have its own sub-directory in thegraphs directory

Value

Character vector of messages produced by OTP, and will return themessage "Graph built" if successful

See Also

Other setup:otp_check_java(),otp_check_version(),otp_dl_demo(),otp_dl_jar(),otp_make_config(),otp_setup(),otp_stop(),otp_validate_config(),otp_write_config()

Examples

## Not run:log<- otp_build_graph(otp="C:/otp/otp.jar", dir="C:/data")## End(Not run)

Description

Check if you have the correct version of Java for running OTP locally

Usage

otp_check_java(otp_version=1.5)

Arguments

See Also

Other setup:otp_build_graph(),otp_check_version(),otp_dl_demo(),otp_dl_jar(),otp_make_config(),otp_setup(),otp_stop(),otp_validate_config(),otp_write_config()

Description

Check the what version of OTP the server is running

Usage

otp_check_version(otpcon, warn=TRUE)

Arguments

See Also

Other setup:otp_build_graph(),otp_check_java(),otp_dl_demo(),otp_dl_jar(),otp_make_config(),otp_setup(),otp_stop(),otp_validate_config(),otp_write_config()

Description

Defines the parameters required to connect to a router on an OTP instanceand, if required, confirms that the instance and router are query-able.

Usage

otp_connect(  hostname="localhost",  router="default",  url=NULL,  port=8080,  ssl=FALSE,  check=TRUE,  timezone= Sys.timezone(),  otp_version=1.5)

Arguments

Details

The default URL structure for the OTP API is:http://<hostname>:<port>/otp/routers/<router> For example:http://localhost:8080/otp/routers/default

Functions construct the URL from the parameters provided in otpconnectobjects. However some websites hosting OTP have modified the default URLstructure. If this is the case you can use theurl parameter to bypassthe URL construction and provide a fully formed URL. In this case thehostname,router,port, andssl are ignored.

Value

Returns an S3 object of class otpconnect. Ifcheck is TRUE andthe router is not reachable the object is not returned.

Examples

## Not run:otpcon<- otp_connect()otpcon<- otp_connect(  router="UK2018",  ssl=TRUE)otpcon<- otp_connect(  hostname="ec2.us-west-2.compute.amazonaws.com",  router="UK2018",  port=8888,  ssl=TRUE)otpcon<- otp_connect(  url="https://api.digitransit.fi:443/routing/v1/routers/hsl")## End(Not run)

Description

Download the demonstration data for the Isle of Wight

Usage

otp_dl_demo(  path_data=NULL,  url= paste0("https://github.com/ropensci/opentripplanner/","releases/download/0.1/isle-of-wight-demo.zip"),  quiet=FALSE)

Arguments

See Also

Other setup:otp_build_graph(),otp_check_java(),otp_check_version(),otp_dl_jar(),otp_make_config(),otp_setup(),otp_stop(),otp_validate_config(),otp_write_config()

Examples

## Not run:otp_dl_demo(tempdir())## End(Not run)

Description

Download the OTP jar file from maven.org

Usage

otp_dl_jar(  path=NULL,  version="1.5.0",  file_name= paste0("otp-", version,"-shaded.jar"),  url="https://repo1.maven.org/maven2/org/opentripplanner/otp",  quiet=FALSE,  cache=TRUE)

Arguments

Details

As of version 0.3.0.0 'otp_dl_jar' will cache the JAR file withinthe package and ignore the 'path' argument. You can force a new download tobe saved in the 'path' location by setting 'cache = FALSE'.

Value

The path to the OTP file

See Also

Other setup:otp_build_graph(),otp_check_java(),otp_check_version(),otp_dl_demo(),otp_make_config(),otp_setup(),otp_stop(),otp_validate_config(),otp_write_config()

Examples

## Not run:otp_dl_jar(tempdir())## End(Not run)

Description

Geo-coding converts a named place, such as a street name into alng/lat pair.

Usage

otp_geocode(  otpcon=NULL,  query=NULL,  autocomplete=FALSE,  stops=TRUE,  clusters=FALSE,  corners=TRUE,  type="SF")

Arguments

Details

OTP will return a maximum of 10 results

Value

Returns a data.frame of SF POINTS or Coordinates of allthe locations that match 'query'

See Also

Other routing:otp_isochrone(),otp_plan(),otp_pointset(),otp_routing_options(),otp_validate_routing_options()

Examples

## Not run:locations<- otp_geocode(otpcon,"High Street")## End(Not run)

Description

Get the Isochrones from a location

Usage

otp_isochrone(  otpcon=NA,  fromPlace=NA,  fromID=NULL,  mode="CAR",  date_time= Sys.time(),  arriveBy=FALSE,  maxWalkDistance=1000,  routingOptions=NULL,  cutoffSec= c(600,1200,1800,2400,3000,3600),  ncores= max(round(parallel::detectCores()*1.25)-1,1),  timezone= otpcon$timezone)

Arguments

Details

Isochrones are maps of equal travel time,for a given location a map is produced showing how long it takes to reacheach location.

Isochrones are only available from OTP v1.x and will not work with v2.0

Value

Returns a SF data.frame of POLYGONs

See Also

Other routing:otp_geocode(),otp_plan(),otp_pointset(),otp_routing_options(),otp_validate_routing_options()

Examples

## Not run:isochrone1<- otp_isochrone(otpcon, fromPlace= c(-0.1346,51.5292))isochrone2<- otp_isochrone(otpcon,  fromPlace= c(-0.1346,51.5292),  mode= c("WALK","TRANSIT"), cutoffSec= c(600,1200,1800))## End(Not run)

Description

OTP can be configured using three json files 'otp-config.json','build-config.json', and 'router-config.json'. This functioncreates a named list for each config file andpopulates the defaults values.

Usage

otp_make_config(type, version=1)

Arguments

Details

For more details see:http://docs.opentripplanner.org/en/latest/Configuration

See Also

Other setup:otp_build_graph(),otp_check_java(),otp_check_version(),otp_dl_demo(),otp_dl_jar(),otp_setup(),otp_stop(),otp_validate_config(),otp_write_config()

Examples

{  conf<- otp_make_config("build")  conf<- otp_make_config("router")}

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

Details

THis function requires the analysis and pointset features to beenabled during 'otp_setup()'. Thus it will only work with OTP 1.x. For moredetail 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)

Description

This is the main routing function for OTP and can find single ormultiple routes between 'fromPlace' and 'toPlace'.

Usage

otp_plan(  otpcon=NA,  fromPlace=NA,  toPlace=NA,  fromID=NULL,  toID=NULL,  mode="CAR",  date_time= Sys.time(),  arriveBy=FALSE,  maxWalkDistance=1000,  numItineraries=3,  routeOptions=NULL,  full_elevation=FALSE,  get_geometry=TRUE,  ncores= max(round(parallel::detectCores()*1.25)-1,1),  timezone= otpcon$timezone,  distance_balance=FALSE,  get_elevation=FALSE)

Arguments

Details

This function returns a SF data.frame with one row for each leg ofthe journey (a leg is defined by a change in mode). For transit, more thanone route option may be returned and is indicated by the 'route_option'column. The number of different itineraries can be set with the'numItineraries' variable.

## Batch Routing

When passing a matrix or SF data frame object to fromPlace and toPlace'otp_plan' will route in batch mode. In this case the 'ncores' variablewill be used. Increasing 'ncores' will enable multicore routing, the max'ncores' should be 1.25 times the number of cores on your system. Thedefault is 1.25 timees -1 for improved stability.

## Distance Balancing

When using multicore routing each task does not take the same amount oftime. This can result in wasted time between batches. Distance Balancingsorts the routing by the euclidean distance between fromPlace and toPlacebefore routing. This offers a small performance improvement of around fivepercent. As the original order of the inputs is lost fromID and toID mustbe provided.

## Elevation

OTP supports elevation data and can return the elevation profile of theroute if available. OTP returns the elevation profile separately from theXY coordinates, this means there is not direct match between the number ofXY points and the number of Z points. OTP also only returns the elevationprofile for the first leg of the route (this appears to be a bug). If'get_elevation' is TRUE the otp_plan function matches the elevation profileto the XY coordinates to return an SF linestring with XYZ coordinates. Ifyou require a more detailed elevation profile, the full_elevation parameterwill return a nested data.frame with three columns. first and second arereturned from OTP, while distance is the cumulative distance along theroute and is derived from First.

## Route Geometry

The 'get_geometry' provides the option to not return the route geometry,and just return the meta-data (e.g. journey time). This may be useful whencreating an Origin:Destination matrix and also provides a small performanceboost by reduced processing of geometries.

Value

Returns an SF data frame of LINESTRINGs

See Also

Other routing:otp_geocode(),otp_isochrone(),otp_pointset(),otp_routing_options(),otp_validate_routing_options()

Examples

## Not run:otpcon<- otp_connect()otp_plan(otpcon, c(0.1,55.3), c(0.6,52.1))otp_plan(otpcon, c(0.1,55.3), c(0.6,52.1),  mode= c("WALK","TRANSIT"))otp_plan(otpcon, c(0.1,55.3), c(0.6,52.1),  mode="BICYCLE", arriveBy=TRUE,  date_time= as.POSIXct(strptime("2018-06-03 13:30","%Y-%m-%d %H:%M")))## End(Not run)

Description

Pointsets are text files tha can be used by the Analyist feature in OTP 1.5

Usage

otp_pointset(points=NULL, name=NULL, dir=NULL)

Arguments

Details

OTP will return a maximum of 10 results

Value

Returns a data.frame of SF POINTS or Coordinates of allthe locations that match 'query'

See Also

Other routing:otp_geocode(),otp_isochrone(),otp_plan(),otp_routing_options(),otp_validate_routing_options()

Examples

## Not run:locations<- otp_geocode(otpcon,"High Street")## End(Not run)

Description

OTP supports a wide selection of routing options 'otp_plan()' accepts anamed list of these options. This function produces an empty named listof valid options supported by both this package and OTP.

Usage

otp_routing_options()

Details

Supports almost all of the possible options in OTP 1.4. Note that someof the most popular option (mode, date, time, etc.) are set directlyin 'otp_plan()'. If you want to permenaty set an option many are supportedin the config files, see help on 'otp_make_config()'.

http://dev.opentripplanner.org/apidoc/1.4.0/resource_PlannerResource.html

See Also

Other routing:otp_geocode(),otp_isochrone(),otp_plan(),otp_pointset(),otp_validate_routing_options()

Examples

## Not run:routingOptions<- otp_routing_options()routingOptions$walkSpeed<-1.5routingOptions<- otp_validate_routing_options(routingOptions)## End(Not run)

Description

OTP is run in Java and requires Java commands to be typed into thecommand line. The function allows the parameters to be defined inR and automatically passed to Java. This function sets up a localinstance of OTP, for remote versions see documentation.

The function assumes you have run otp_build_graph()

Usage

otp_setup(  otp=NULL,  dir=NULL,  memory=2048,  router="default",  port=8080,  securePort=8081,  analyst=FALSE,  pointsets=FALSE,  wait=TRUE,  flag64bit=TRUE,  quiet=TRUE,  otp_version=NULL,  open_browser=TRUE)

Arguments

Details

To run an OTP graph must have been created using otp_build_graphand the following files to be in the directory specified by thedir variable.

/graphs - A sub-directory

/default - A sub-directory with the name of the OTP router used in 'router' variable

graph.obj OTP graph

Value

This function does not return a value to R. If wait is TRUE Rwill wait until OTP is running (maximum of 5 minutes).After 5 minutes (or if wait is FALSE) the function will returnR to your control, but the OTP will keep loading.

See Also

Other setup:otp_build_graph(),otp_check_java(),otp_check_version(),otp_dl_demo(),otp_dl_jar(),otp_make_config(),otp_stop(),otp_validate_config(),otp_write_config()

Examples

## Not run:otp_setup(  otp="C:/otp/otp.jar",  dir="C:/data")otp_setup(  otp="C:/otp/otp.jar",  dir="C:/data",  memory=5000,  analyst=TRUE)## End(Not run)

Description

OTP is run in Java and requires Java commands to be typedinto the command line. The function allows the parametersto be defined in R and automatically passed to Java.This function stops an already running OTP instance

Usage

otp_stop(warn=TRUE, kill_all=TRUE)

Arguments

Details

The function assumes you have run otp_setup()

Value

This function return a message but no object

See Also

Other setup:otp_build_graph(),otp_check_java(),otp_check_version(),otp_dl_demo(),otp_dl_jar(),otp_make_config(),otp_setup(),otp_validate_config(),otp_write_config()

Examples

## Not run:otp_stop(kill_all=FALSE)## End(Not run)

Description

Evaluate a surface created with 'otp_make_surface' against a pointset madewith 'otp_pointset' to get travel times and statitics from the analysit inOTP 1.x

Usage

otp_surface(  otpcon=NULL,  surface=NULL,  pointsset=NULL,  get_data=TRUE,  ncores=1)

Arguments

Details

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

Value

Returns a list of data.frames of travel times

Examples

## Not run:times<- otp_surface(otpcon, c(-1.17502,50.64590),"lsoa", path_data)## End(Not run)

Description

Make a raster image (picture) of travel time using the surface features inOTP 1.x

Usage

otp_surface_isochrone(otpcon=NULL, surface=NULL)

Arguments

Details

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

Value

Returns a data.frame of travel times

Examples

## Not run:times<- otp_surface(otpcon, c(-1.17502,50.64590),"lsoa", path_data)## End(Not run)

Description

This function requires OTP 1.x and the analyst

Usage

otp_traveltime(  otpcon=NA,  path_data=NULL,  fromPlace=NA,  toPlace=NA,  fromID=NULL,  toID=NULL,  mode="CAR",  date_time= Sys.time(),  arriveBy=FALSE,  maxWalkDistance=1000,  numItineraries=3,  routeOptions=NULL,  ncores= max(round(parallel::detectCores()*1.25)-1,1),  timezone= otpcon$timezone)

Arguments

Details

Make a travel time matrix using the analyst features in OPT 1.x

Value

Returns an data frame

See Also

Other analyst:otp_make_surface()

Description

Checks if the list of OTP configuration options is valid

Usage

otp_validate_config(config, type= attributes(config)$config_type, version=1)

Arguments

Details

Performs basic validity checks on class, max/min values etc as appropriate,some of more complex parameters are not checked. For more details see:

http://docs.opentripplanner.org/en/latest/Configurationhttp://dev.opentripplanner.org/javadoc/1.3.0/org/opentripplanner/routing/core/RoutingRequest.html

See Also

Other setup:otp_build_graph(),otp_check_java(),otp_check_version(),otp_dl_demo(),otp_dl_jar(),otp_make_config(),otp_setup(),otp_stop(),otp_write_config()

Examples

## Not run:conf<- otp_make_config("build")otp_validate_config(conf)## End(Not run)

Description

OTP supports a wide selection of routing options 'otp_plan()' accepts anamed list of these options. This function validates a named list of inputsand removes any empty inputs.

Usage

otp_validate_routing_options(opts)

Arguments

Details

Supports almost all of the possible options in OTP 1.4. Note that someof the most popular option (mode, date, time, etc.) are set directlyin 'otp_plan()'. If you want to permenaty set an option many are supportedin the config files, see help on 'otp_make_config()'.http://dev.opentripplanner.org/apidoc/1.4.0/resource_PlannerResource.html

See Also

Other routing:otp_geocode(),otp_isochrone(),otp_plan(),otp_pointset(),otp_routing_options()

Examples

## Not run:routingOptions<- otp_routing_options()routingOptions$walkSpeed<-1.5routingOptions<- otp_validate_routing_options(routingOptions)## End(Not run)

Description

Takes a config list produced by 'otp_make_config()' and saves itas json file for OTP

Usage

otp_write_config(config, dir=NULL, router="default")

Arguments

See Also

Other setup:otp_build_graph(),otp_check_java(),otp_check_version(),otp_dl_demo(),otp_dl_jar(),otp_make_config(),otp_setup(),otp_stop(),otp_validate_config()

Examples

## Not run:conf<- otp_make_config("build")otp_write_config(conf, dir= tempdir())## End(Not run)