From 13dd12c4c63690748e2283b7614ccdfa1f7d1249 Mon Sep 17 00:00:00 2001 From: kiernann Date: Fri, 10 Nov 2023 01:07:41 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20kiernann?= =?UTF-8?q?/metro@4aca3233af1383056883049c52bb071d21e877b4=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 404.html | 2 +- LICENSE-text.html | 2 +- LICENSE.html | 2 +- authors.html | 9 ++-- index.html | 79 ++++++++++++++++--------------- news/index.html | 10 +++- pkgdown.yml | 2 +- reference/bus_departs.html | 9 ++-- reference/bus_incidents.html | 2 +- reference/bus_path.html | 2 +- reference/bus_position.html | 2 +- reference/bus_routes.html | 2 +- reference/bus_schedule.html | 2 +- reference/bus_stops.html | 2 +- reference/elevator_incidents.html | 2 +- reference/index.html | 2 +- reference/metro-package.html | 2 +- reference/metro_lines.html | 2 +- reference/metro_routes.html | 2 +- reference/metro_stations.html | 2 +- reference/metro_stops.html | 2 +- reference/next_bus.html | 2 +- reference/next_train.html | 2 +- reference/no_data_now.html | 2 +- reference/rail_destination.html | 2 +- reference/rail_entrance.html | 2 +- reference/rail_incidents.html | 2 +- reference/rail_lines.html | 2 +- reference/rail_path.html | 2 +- reference/rail_positions.html | 4 +- reference/rail_stations.html | 2 +- reference/rail_times.html | 2 +- reference/standard_routes.html | 2 +- reference/station_info.html | 2 +- reference/track_circuits.html | 2 +- reference/wmata_api.html | 2 +- reference/wmata_key.html | 2 +- 37 files changed, 94 insertions(+), 81 deletions(-) diff --git a/404.html b/404.html index ec50cb8..0626830 100644 --- a/404.html +++ b/404.html @@ -39,7 +39,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/LICENSE-text.html b/LICENSE-text.html index 5fab218..a7dc72c 100644 --- a/LICENSE-text.html +++ b/LICENSE-text.html @@ -17,7 +17,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/LICENSE.html b/LICENSE.html index ec1f9b9..c57038b 100644 --- a/LICENSE.html +++ b/LICENSE.html @@ -17,7 +17,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/authors.html b/authors.html index 4775c46..15f714a 100644 --- a/authors.html +++ b/authors.html @@ -17,7 +17,7 @@ metro - 0.9.2 + 0.9.2.9000 @@ -63,15 +63,16 @@

Citation

Nicholls K (2023). metro: Washington Metropolitan Area Transit Authority API. -https://github.com/kiernann/metro, -https://kiernann.github.io/metro/. +R package version 0.9.2.9000, +https://kiernann.github.io/metro/, https://github.com/kiernann/metro. 

@Manual{,
   title = {metro: Washington Metropolitan Area Transit Authority API},
   author = {Kiernan Nicholls},
   year = {2023},
-  note = {https://github.com/kiernann/metro,
+  note = {R package version 0.9.2.9000, 
 https://kiernann.github.io/metro/},
+  url = {https://github.com/kiernann/metro},
 }
diff --git a/index.html b/index.html index 0bc422a..8911d2c 100644 --- a/index.html +++ b/index.html @@ -44,7 +44,7 @@ metro - 0.9.2 + 0.9.2.9000 @@ -107,19 +107,19 @@

Example
 library(metro)
 packageVersion("metro")
-#> [1] '0.9.1.9002'
+#> [1] '0.9.2'

Functions return data frames for easy analysis.

 next_train(StationCodes = "A01")
-#> # A tibble: 6 x 9
+#> # A tibble: 6 × 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    -1
-#> 2     8 Glenmont    B11             Glenmont            1 RD    A01          Metro Center     4
-#> 3     8 Shady Gr    A15             Shady Grove         2 RD    A01          Metro Center     5
-#> 4     8 Shady Gr    A15             Shady Grove         2 RD    A01          Metro Center     8
-#> 5     8 Glenmont    B11             Glenmont            1 RD    A01          Metro Center    10
-#> 6     8 Shady Gr    A15             Shady Grove         2 RD    A01          Metro Center    16
+#> 1 6 Glenmont B11 Glenmont 1 RD A01 Metro Center -1 +#> 2 6 Shady Grove <NA> Shady Grove 2 RD A01 Metro Center -1 +#> 3 8 Glenmont B11 Glenmont 1 RD A01 Metro Center 1 +#> 4 8 Glenmont B11 Glenmont 1 RD A01 Metro Center 6 +#> 5 6 Shady Grove <NA> Shady Grove 2 RD A01 Metro Center 6 +#> 6 6 Shady Grove <NA> Shady Grove 2 RD A01 Metro Center 18

Coordinates

@@ -127,14 +127,15 @@

Coordinates
 # Washington Monument coordinates
 rail_entrance(Lat = 38.890, Lon = -77.035, Radius = 750)[, -(3:4)]
-#> # A tibble: 5 x 5
-#>   Name                                                         StationCode   Lat   Lon Distance
-#>   <chr>                                                        <chr>       <dbl> <dbl>    <dbl>
-#> 1 NORTH ENTRANCE (MALL EXIT, NORTHEAST OF 12TH ST & JEFERSON … D02          38.9 -77.0     582.
-#> 2 SOUTH ELEVATOR ENTRANCE (NORTHWEST CORNER OF 12TH ST & INDE… D02          38.9 -77.0     612.
-#> 3 SOUTH ENTRANCE (SOUTHWEST CORNER OF 12TH ST & INDEPENDENCE … D02          38.9 -77.0     626.
-#> 4 MAIN ENTRANCE (WEST SIDE 12TH BETWEEN PENNSYLVANIA &  CONNE… D01          38.9 -77.0     672.
-#> 5 ELEVATOR ENTRANCE (WEST SIDE 12TH BETWEEN PENNSYLVANIA &  C… D01          38.9 -77.0     714.

+#> # A tibble: 6 × 5 +#> Name StationCode Lat Lon Distance +#> <chr> <chr> <dbl> <dbl> <dbl> +#> 1 12TH ST NW & JEFERSON DR SW D02 38.9 -77.0 582. +#> 2 12TH ST SW & INDEPENDENCE AVE SW (ELEVATOR) D02 38.9 -77.0 612. +#> 3 12TH ST SW & INDEPENDENCE AVE SW D02 38.9 -77.0 626. +#> 4 12TH ST NW & PENNSYLVANIA AVE NW D01 38.9 -77.0 672. +#> 5 13TH ST NW & PENNSYLVANIA AVE NW (BUILDING) D01 38.9 -77.0 685. +#> 6 12TH ST NW & PENNSYLVANIA AVE NW (ELEVATOR) D01 38.9 -77.0 714.

Dates and Times @@ -142,25 +143,28 @@

Dates and TimesDate columns with class POSIXt have been shifted from Eastern time to the UTC time zone (+5 hours).

 bus_position(RouteId = "33")[, 1:8]
-#> # A tibble: 4 x 8
-#>   VehicleID   Lat   Lon Distance Deviation DateTime            TripID     RouteID
-#>   <chr>     <dbl> <dbl>    <dbl>     <dbl> <dttm>              <chr>      <chr>  
-#> 1 6502       38.9 -77.0       NA         8 2021-03-05 19:36:32 1932532080 33     
-#> 2 6202       38.9 -77.1       NA        -4 2021-03-05 19:36:41 1932489080 33     
-#> 3 6497       38.9 -77.1       NA         3 2021-03-05 19:36:41 1932531080 33     
-#> 4 7117       38.9 -77.0       NA         6 2021-03-05 19:36:48 1932487080 33
+#> # A tibble: 7 × 8 +#> VehicleID Lat Lon Distance Deviation DateTime TripID RouteID +#> <chr> <dbl> <dbl> <dbl> <dbl> <dttm> <chr> <chr> +#> 1 4611 38.9 -77.0 NA 22 2023-11-10 00:14:31 29636020 33 +#> 2 7116 39.0 -77.1 NA 0 2023-11-10 00:14:08 18078020 33 +#> 3 4572 38.9 -77.0 NA 14 2023-11-10 00:14:16 29847020 33 +#> 4 7111 39.0 -77.1 NA -3 2023-11-10 00:14:08 46929020 33 +#> 5 4583 38.9 -77.1 NA 6 2023-11-10 00:14:15 16581020 33 +#> 6 7107 38.8 -77.4 NA 32 2023-11-10 00:14:35 6694020 33 +#> 7 7134 38.9 -77.0 NA 9 2023-11-10 00:14:30 26108020 33

Time values are left in Eastern time 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 (past midnight), this would be represented as 25:21.

-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:49
+tail(rail_times(StationCode = "E10")) +#> # A tibble: 6 × 7 +#> StationCode StationName DestinationStation Weekday OpeningTime FirstTime LastTime +#> <chr> <chr> <chr> <chr> <time> <time> <time> +#> 1 E10 Greenbelt F11 Tue 04:50 05:00 23:30 +#> 2 E10 Greenbelt F11 Wed 04:50 05:00 23:30 +#> 3 E10 Greenbelt F11 Thu 04:50 05:00 23:30 +#> 4 E10 Greenbelt F11 Fri 04:50 05:00 26:30 +#> 5 E10 Greenbelt F11 Sat 06:50 07:00 26:30 +#> 6 E10 Greenbelt F11 Sun 06:50 07:00 23:30

Data @@ -168,7 +172,7 @@

Data

Some 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
+#> # A tibble: 6 × 5
 #>   LineCode DisplayName StartStationCode EndStationCode InternalDestination
 #>   <chr>    <chr>       <chr>            <chr>          <list>             
 #> 1 BL       Blue        J03              G05            <chr [0]>          
@@ -220,10 +224,9 @@ 
Developers

 

 
Dev status

 
    
-
  • Lifecycle: maturing
    • 
+
  • Lifecycle: experimental
    • 
 
  • CRAN status
    • 
-
  • Codecov test coverage
    • 
-
  • CodeFactor
    • 
+
  • Codecov test coverage
    • 
 
  • R build status
    • 
 

 

diff --git a/news/index.html b/news/index.html
index 911e087..5500c38 100644
--- a/news/index.html
+++ b/news/index.html
@@ -17,7 +17,7 @@
       
       
         metro
-        0.9.2
+        0.9.2.9000
@@ -48,7 +48,13 @@

Changelog

-

metro 0.9.2

+

metro (development version)

+
  • Due to an error in the rail timing endpoint, the rail_times() function can only return example data for the time being. (#15)
    • +
  • Due to an error in the train position endpoint, the train_position() function can only return example data for the time being. (#16)
    • +
  • Add StopId column to bus_departs() and use current date in the example.
    • +
+
+

metro 0.9.22023-10-28

  • Update to new package doc help page.
  • bus_schedule() now correctly merges both directions (thanks Prof. Moore!)
    • diff --git a/pkgdown.yml b/pkgdown.yml index 94152d0..4e813bb 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 2.19.2 pkgdown: 2.0.7 pkgdown_sha: ~ articles: {} -last_built: 2023-10-28T15:46Z +last_built: 2023-11-10T01:07Z urls: reference: https://kiernann.com/metro/reference article: https://kiernann.com/metro/articles diff --git a/reference/bus_departs.html b/reference/bus_departs.html index 689ece3..80c7c9d 100644 --- a/reference/bus_departs.html +++ b/reference/bus_departs.html @@ -17,7 +17,7 @@ metro - 0.9.2 + 0.9.2.9000
@@ -58,7 +58,10 @@

Bus Schedule at Stop

Format

-

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

ScheduleTime
+

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

StopID
+

7-digit regional ID which can be used in various bus-related

+ +
ScheduleTime

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

@@ -128,7 +131,7 @@

See also

Examples

if (FALSE) {
-bus_departs(1001195, "2021-01-01")
+bus_departs(1001195, Sys.Date())
 }
diff --git a/reference/bus_incidents.html b/reference/bus_incidents.html index 72c0367..f592a01 100644 --- a/reference/bus_incidents.html +++ b/reference/bus_incidents.html @@ -18,7 +18,7 @@ metro - 0.9.2 + 0.9.2.9000
diff --git a/reference/bus_path.html b/reference/bus_path.html index 0168919..f5299a2 100644 --- a/reference/bus_path.html +++ b/reference/bus_path.html @@ -18,7 +18,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/bus_position.html b/reference/bus_position.html index e282898..9a248a8 100644 --- a/reference/bus_position.html +++ b/reference/bus_position.html @@ -18,7 +18,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/bus_routes.html b/reference/bus_routes.html index 20a574d..63cd907 100644 --- a/reference/bus_routes.html +++ b/reference/bus_routes.html @@ -18,7 +18,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/bus_schedule.html b/reference/bus_schedule.html index 58de6ab..6f08b7d 100644 --- a/reference/bus_schedule.html +++ b/reference/bus_schedule.html @@ -17,7 +17,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/bus_stops.html b/reference/bus_stops.html index 9a06af0..9f68012 100644 --- a/reference/bus_stops.html +++ b/reference/bus_stops.html @@ -18,7 +18,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/elevator_incidents.html b/reference/elevator_incidents.html index 34b9fa8..8f2a345 100644 --- a/reference/elevator_incidents.html +++ b/reference/elevator_incidents.html @@ -17,7 +17,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/index.html b/reference/index.html index ea4254b..74d88e3 100644 --- a/reference/index.html +++ b/reference/index.html @@ -17,7 +17,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/metro-package.html b/reference/metro-package.html index bb81d6e..725017e 100644 --- a/reference/metro-package.html +++ b/reference/metro-package.html @@ -22,7 +22,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/metro_lines.html b/reference/metro_lines.html index 25c199f..ae0162f 100644 --- a/reference/metro_lines.html +++ b/reference/metro_lines.html @@ -17,7 +17,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/metro_routes.html b/reference/metro_routes.html index 8d4898a..4e99ff7 100644 --- a/reference/metro_routes.html +++ b/reference/metro_routes.html @@ -17,7 +17,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/metro_stations.html b/reference/metro_stations.html index 1e2dd7e..18da45d 100644 --- a/reference/metro_stations.html +++ b/reference/metro_stations.html @@ -17,7 +17,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/metro_stops.html b/reference/metro_stops.html index 7c08a2d..a84ead8 100644 --- a/reference/metro_stops.html +++ b/reference/metro_stops.html @@ -17,7 +17,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/next_bus.html b/reference/next_bus.html index 5ed5558..e35addf 100644 --- a/reference/next_bus.html +++ b/reference/next_bus.html @@ -17,7 +17,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/next_train.html b/reference/next_train.html index e7dc235..d312635 100644 --- a/reference/next_train.html +++ b/reference/next_train.html @@ -19,7 +19,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/no_data_now.html b/reference/no_data_now.html index 085b691..2cd67ff 100644 --- a/reference/no_data_now.html +++ b/reference/no_data_now.html @@ -17,7 +17,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/rail_destination.html b/reference/rail_destination.html index cbb1fa7..1313ef3 100644 --- a/reference/rail_destination.html +++ b/reference/rail_destination.html @@ -19,7 +19,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/rail_entrance.html b/reference/rail_entrance.html index c4bc7c8..dad638f 100644 --- a/reference/rail_entrance.html +++ b/reference/rail_entrance.html @@ -18,7 +18,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/rail_incidents.html b/reference/rail_incidents.html index 0a63df5..e252687 100644 --- a/reference/rail_incidents.html +++ b/reference/rail_incidents.html @@ -18,7 +18,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/rail_lines.html b/reference/rail_lines.html index c43116f..a79ca7a 100644 --- a/reference/rail_lines.html +++ b/reference/rail_lines.html @@ -17,7 +17,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/rail_path.html b/reference/rail_path.html index 7ff6056..b393a27 100644 --- a/reference/rail_path.html +++ b/reference/rail_path.html @@ -18,7 +18,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/rail_positions.html b/reference/rail_positions.html index 3cb5fa3..c6d8a67 100644 --- a/reference/rail_positions.html +++ b/reference/rail_positions.html @@ -19,7 +19,7 @@ metro - 0.9.2 + 0.9.2.9000 @@ -57,7 +57,7 @@

Live Train Positions

- 
rail_positions(api_key = api_key)
+ 
rail_positions(api_key = wmata_key())
diff --git a/reference/rail_stations.html b/reference/rail_stations.html index 4081df5..3b9b04b 100644 --- a/reference/rail_stations.html +++ b/reference/rail_stations.html @@ -19,7 +19,7 @@ metro - 0.9.2 + 0.9.2.9000
diff --git a/reference/rail_times.html b/reference/rail_times.html index 64164cd..be887f9 100644 --- a/reference/rail_times.html +++ b/reference/rail_times.html @@ -19,7 +19,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/standard_routes.html b/reference/standard_routes.html index 8e5204a..99ff959 100644 --- a/reference/standard_routes.html +++ b/reference/standard_routes.html @@ -19,7 +19,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/station_info.html b/reference/station_info.html index 5aeccf5..7996b9a 100644 --- a/reference/station_info.html +++ b/reference/station_info.html @@ -19,7 +19,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/track_circuits.html b/reference/track_circuits.html index 2ff38b6..a67d6fc 100644 --- a/reference/track_circuits.html +++ b/reference/track_circuits.html @@ -19,7 +19,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/wmata_api.html b/reference/wmata_api.html index c4d303a..0b68719 100644 --- a/reference/wmata_api.html +++ b/reference/wmata_api.html @@ -19,7 +19,7 @@ metro - 0.9.2 + 0.9.2.9000 diff --git a/reference/wmata_key.html b/reference/wmata_key.html index 96f1d2d..b5d8c70 100644 --- a/reference/wmata_key.html +++ b/reference/wmata_key.html @@ -34,7 +34,7 @@ metro - 0.9.2 + 0.9.2.9000