makexmlsiri: Create the required XML files for SIRI downloads

Description Usage Arguments Details Value See Also

View source: R/makexmlsiri.R

Description

Creates XML files used for sending SIRI requests to Israel's MOT API.

Usage

1
2
3
4
5
6
7
8
9
makexmlsiri(
  stop_codes,
  route_codes,
  wd = NULL,
  xml_size = 200,
  RequestorRef = NULL,
  xml_name = "xml",
  newfolder = TRUE
)

Arguments

stop_codes

A vector of stop_code integers taken from the GTFS tables. the XML will not fail to create if there are no integers.

route_codes

A vector of route_id integers taken from the GTFS tables. the XML will not fail to create if there are no integers.

wd

the working directory to write the files in, if newfolder is TRUE a new folder called 'xml' will be created, if there allready is a folder called 'xml' in the working directory a prompt window will ask you to choose a new folder name.

xml_size

Default is 200, the number of stops written to each XML file.

RequestorRef

A unique Requestor key supplied by the Israeli MOT, it is needed since the API requires registration and a static IP address.

xml_name

the prefix to be used for the new XML files. default is 'xml'.

newfolder

Create a new folder for the files?

Details

Creates XML files used for sending SIRI requests to Israel's MOT API. note that an API key "RequestorRef" is needed for the process. It is recommended to use a single sorted table containing both stop_codes and route_ids.

Value

Returns a string message, and files written to working directory.

See Also

SIRItoGTFS


bogind/SIRItoGTFS documentation built on March 14, 2021, 10:01 p.m.