bus_departs: Bus Schedule at Stop

View source: R/bus-departs.R

bus_departsR Documentation

Bus Schedule at Stop

Description

Returns a set of buses scheduled at a stop for a given date.

Usage

bus_departs(StopID, Date = NULL, api_key = wmata_key())

Arguments

StopID

7-digit regional stop ID.

Date

(Optional) Date for which to retrieve route and stop information.

api_key

Subscription key which provides access to this API. Defaults Sys.getenv("WMATA_KEY") via wmata_key().

Format

A tibble with 1 row per bus departure and 8 variables:

ScheduleTime

Date and time (UTC) when the bus is scheduled to stop at this location.

DirectionNum

Denotes a binary direction (0 or 1) of the bus. There is no specific mapping to direction, but a different value for the same route signifies that the buses are traveling in opposite directions. Use the TripDirectionText column to show the actual destination of the bus.

StartTime

Scheduled start date and time (UTC) for this trip.

EndTime

Scheduled end date and time (UTC) for this trip.

RouteID

Bus route variant identifier (pattern). This variant can be used in several other bus methods which accept variants. Note that customers will never see anything other than the base route name, so variants 10A, 10Av1, 10Av2, etc. will be displayed as 10A on the bus.

TripDirectionText

General direction of the trip (e.g.: NORTH, SOUTH, EAST, WEST).

TripHeadsign

Destination of the bus.

TripID

Trip identifier. This can be correlated with the data in our bus schedule information as well as bus positions.

Value

Data frame containing scheduled arrival information.

See Also

https://developer.wmata.com/docs/services/54763629281d83086473f231/operations/5476362a281d830c946a3d6c/console

Other Bus Route and Stop Methods: bus_path(), bus_position(), bus_routes(), bus_schedule(), bus_stops()

Examples

## Not run: 
bus_departs(1001195, "2021-01-01")

## End(Not run)

metro documentation built on Nov. 2, 2023, 6:06 p.m.