add example #113 for 'frequencies_to_stop_times'

UrbanAnalyst · Oct 28, 2024 · 0c650b1 · 0c650b1
1 parent f44364f
commit 0c650b1
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 2 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: gtfsrouter
 Title: Routing with 'GTFS' (General Transit Feed Specification) Data
-Version: 0.1.2.022
+Version: 0.1.2.023
 Authors@R: c(
     person("Mark", "Padgham", , "mark.padgham@email.com", role = c("aut", "cre")),
     person("Marcin", "Stepniak", , "marcinstepniak@ucm.es", role = "aut",

diff --git a/R/frequencies_to_stop_times.R b/R/frequencies_to_stop_times.R
@@ -12,6 +12,14 @@
 #'
 #' @family augment
 #' @export
+#'
+#' @examples
+#' \dontrun{
+#' # Presume an input feed has been created and includes a "frequencies" table:
+#' gtfs2 <- frequencies_to_stop_times (gtfs)
+#' # "gtfs2" will then have an expanded "stop_times" table, with all
+#' # "frequencies" entries converted to equivalent absolute stop times.
+#' }
 frequencies_to_stop_times <- function (gtfs) {
 
     # check if gtfs is a gtfs class of object

diff --git a/codemeta.json b/codemeta.json
@@ -7,7 +7,7 @@
   "codeRepository": "https://github.com/UrbanAnalyst/gtfsrouter",
   "issueTracker": "https://github.com/UrbanAnalyst/gtfsrouter/issues",
   "license": "https://spdx.org/licenses/GPL-3.0",
-  "version": "0.1.2.022",
+  "version": "0.1.2.023",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",

diff --git a/man/frequencies_to_stop_times.Rd b/man/frequencies_to_stop_times.Rd