Ttravelperformance: Query performance statistics for many trips contained in a...

In MBTAr: Access Data from the Massachusetts Bay Transit Authority (MBTA) Web API

Description

Returns travel time performance statistics for many sets of trips with specified origin-destination pairs and specific time periods.

Usage

Ttravelperformance(enter_time, exit_time = NULL, enter_route_name, exit_route_name,
enter_stop_name, exit_stop_name, data, api_key)

Arguments

enter_time	Name of column in data that specifies entrance times for the trips for which performance is to be returned.
exit_time	Name of column in data that specifies exit times for the trips for which performance is to be returned. Defaults to 30 minutes from the enter_time value.
enter_route_name	Name of column in data that specifies GTFS-compatible route ID for entrance stations.
exit_route_name	Name of column in data that specifies GTFS-compatible route ID for exit stations. Travel time API request only available for single unlinked rides as of Release v2.
enter_stop_name	Name of column in data that specifies human-readable text name for the stop where trips began (origin name).
exit_stop_name	Name of column in data that specifies human-readable text name for the stop where trips ended (destination name).
data	Dataframe from which holds the previously named arguments.
api_key	API key for MBTA API. To obtain one, visit the MBTA Developer Portal (https://mbta.com/developers/mbta-performance/)

Value

Dataframe containing the following:

traveltime_mean	Mean travel time between origin and destination stops during the time period specified.
traveltime_bench	Benchmark travel times between origin and destination stops during the time period specified. Benchmarks come from historical data over the past 30 days for travel times.
traveltime_perf	Average travel time as a proportion of the benchmark time, or traveltime_mean/traveltime_bench.

See Also

Ttraveltimes

MBTAr documentation built on May 2, 2019, 6:59 a.m.