The goal of metro is to return data frames from the Washington Metropolitan Area Transit Authority API. Nested lists have been converted to tidy data frames when possible.
You can install the development version of metro from GitHub:
Usage of the WMATA API requires a developer API key. Such a key can be obtained by creating a developer account and subscribing to the free default tier.
The WMATA also provides a demo key to try out the various features of the API. This key should never be used in production, it is rate limited and subject to change at any time.
As of February 2021, the demo key can be used like this:
Functions return data frames for easy analysis.
next_train(StationCodes = "A01")
#> # A tibble: 6 x 9
#> Car Destination DestinationCode DestinationName Group Line LocationCode LocationName Min
#> <int> <chr> <chr> <chr> <int> <chr> <chr> <chr> <int>
#> 1 8 Glenmont B11 Glenmont 1 RD A01 Metro Center 2
#> 2 8 Glenmont B11 Glenmont 1 RD A01 Metro Center 6
#> 3 8 Shady Gr A15 Shady Grove 2 RD A01 Metro Center 10
#> 4 8 Glenmont B11 Glenmont 1 RD A01 Metro Center 11
#> 5 8 Shady Gr A15 Shady Grove 2 RD A01 Metro Center 23
#> 6 NA Shady Gr A15 Shady Grove 2 RD A01 Metro Center 39Use coordinates to find station entrances or bus stops near a location. The geodist::geodist() function is used to calculate distance from the supplied coordinates.
# White House coordinates
rail_entrance(Lat = 38.8979, Lon = -77.0365, Radius = 500)[, -4]
#> # A tibble: 3 x 6
#> Name StationCode StationTogether Lat Lon Distance
#> <chr> <chr> <chr> <dbl> <dbl> <dbl>
#> 1 WEST ENTRANCE (VERMONT & I STs) C02 <NA> 38.9 -77.0 383.
#> 2 EAST ENTRANCE (EAST OF 17th & I STs) C03 <NA> 38.9 -77.0 430.
#> 3 EAST ENTRANCE (14TH & I STs) C02 <NA> 38.9 -77.0 499.Date columns with class POSIXt have been converted to the UTC time zone.
bus_position(RouteId = "L2")[, 1:8]
#> # A tibble: 4 x 8
#> VehicleID Lat Lon Distance Deviation DateTime TripID RouteID
#> <chr> <dbl> <dbl> <dbl> <dbl> <dttm> <chr> <chr>
#> 1 7154 39.0 -77.1 NA 0 2021-02-24 02:27:40 1909112020 L2
#> 2 6514 38.9 -77.0 NA 0 2021-02-24 02:27:37 1909149020 L2
#> 3 7165 38.9 -77.1 NA -3 2021-02-24 02:27:31 1909113020 L2
#> 4 7167 38.9 -77.1 NA 2 2021-02-24 02:27:40 1909150020 L2Time values are left in EST and are represented using the class hms, which counts the seconds since midnight. If the last train on a Saturday leaves at 1:21 AM on Sunday, this would be represented as 25:31 for Saturday.
tail(rail_times(StationCode = "A07"))
#> # A tibble: 6 x 7
#> StationCode StationName DestinationStation Weekday OpeningTime FirstTime LastTime
#> <chr> <chr> <chr> <chr> <time> <time> <time>
#> 1 A07 Tenleytown-AU A15 Fri 05:14 05:46 25:21
#> 2 A07 Tenleytown-AU B11 Fri 05:14 05:24 24:49
#> 3 A07 Tenleytown-AU A15 Sat 07:14 07:46 25:21
#> 4 A07 Tenleytown-AU B11 Sat 07:14 07:24 24:49
#> 5 A07 Tenleytown-AU A15 Sun 08:14 08:46 23:21
#> 6 A07 Tenleytown-AU B11 Sun 08:14 08:24 22:49Some data frames are includes as objects if their functions typically return the same thing every time.
metro_lines # rail_lines() for live
#> # A tibble: 6 x 5
#> LineCode DisplayName StartStationCode EndStationCode InternalDestination
#> <chr> <chr> <chr> <chr> <list>
#> 1 BL Blue J03 G05 <chr [0]>
#> 2 GR Green F11 E10 <chr [0]>
#> 3 OR Orange K08 D13 <chr [0]>
#> 4 RD Red A15 B11 <chr [2]>
#> 5 SV Silver N06 G05 <chr [0]>
#> 6 YL Yellow C15 E06 <chr [1]>