process: Process 'StationBoard' request

Description Usage Arguments Value

View source: R/trainR.R

Description

Process StationBoard request

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
process(
  crs,
  filterCrs = NA,
  filterType = "to",
  numRows = 150,
  timeOffset = 0,
  timeWindow = 120,
  token = get_token(),
  url = "https://lite.realtime.nationalrail.co.uk/OpenLDBWS/ldb11.asmx",
  verbose = FALSE,
  class = NULL,
  extra = "StationBoard"
)

Arguments

crs

(string, 3 characters, alphabetic): The CRS code of the location for which the request is being made.

filterCrs

(string, 3 characters, alphabetic): The CRS code of either an origin or destination location to filter in. Optional.

filterType

(string, either "from" or "to"): The type of filter to apply. Filters services to include only those originating or terminating at the filterCrs location. Defaults to "to".

numRows

(integer, between 0 and 150 exclusive): The number of services to return in the resulting station board.

timeOffset

(integer, between -120 and 120 exclusive): An offset in minutes against the current time to provide the station board for. Defaults to 0.

timeWindow

(integer, between -120 and 120 exclusive): How far into the future in minutes, relative to timeOffset, to return services for. Defaults to 120.

token

Token to access the data feed. The token can be obtained at http://realtime.nationalrail.co.uk/OpenLDBWSRegistration/.

class

String with request class.

extra

String with extra classes (default = "StationBoard").

Value

Tibble with request data.


villegar/trainR documentation built on Aug. 14, 2021, 10:23 p.m.