otp_build_graph: Build an OTP Graph

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

Build an OTP Graph

Description

OTP is run in Java and requires Java commands to be typed into the command line. The function allows the parameters to be defined in R and automatically passed to Java. This function builds a OTP graph from the Open 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

otp	A character string, path to the OTP .jar file
dir	A character string, path to a directory containing the necessary files, see details
memory	A positive integer. Amount of memory to assign to the OTP in MB, default is 2048
router	A character string for the name of the router, must subfolder of dir/graphs, default "default". See vignettes for details.
flag64bit	Logical, if true the -d64 flag is added to Java instructions, ignored if otp_version >= 2
quiet	Logical, if FALSE the Java commands will be printed to console
otp_version	Numeric, version of OTP to build, default NULL when version is auto-detected

Details

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

To build an OTP graph requires the following files to be in the directory specified 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 settings for 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 be the only .jar file in that directory OTP can support multiple routers (e.g. different regions), each router must have its own sub-directory in the graphs directory

Value

Character vector of messages produced by OTP, and will return the message "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)

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