standard_routes {metro} | R Documentation |
Standard Routes
Description
Returns an ordered list of mostly revenue (and some lead) track circuits, arranged by line and track number. This data does not change frequently and should be cached for a reasonable amount of time.
Usage
standard_routes()
Format
A nested tibble with 1 row per track and 3 variables:
- LineCode
Abbreviation for the revenue line. Note that this also includes YLRP (Yellow Line Rush Plus).
- TrackNum
Track number (1 or 2).
- TrackCircuits
Array containing ordered track circuit information:
-
CircuitId
: An internal system-wide uniquely identifiable circuit number. -
SeqNum
: Order in which the circuit appears for the given line and track. Sequences go from West to East and South to North. -
StationCode
: If the circuit is at a station, this value will represent the station code. Otherwise, it will be beNA
. Use this value in other rail-related APIs to retrieve data about a station.
-
Details
Please refer to this page for additional details.
Value
A nested data frame of track circuits.
See Also
Other Train Positions:
rail_positions()
,
track_circuits()
Examples
## Not run:
standard_routes()
## End(Not run)