add example to berlin_gtfs_to_zip for #113

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

Hide file tree

Showing 4 changed files with 14 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.021
+Version: 0.1.2.022
 Authors@R: c(
     person("Mark", "Padgham", , "[email protected]", role = c("aut", "cre")),
     person("Marcin", "Stepniak", , "[email protected]", role = "aut",

diff --git a/R/utils.R b/R/utils.R
@@ -6,6 +6,12 @@
 #' @return Path to newly created zip file
 #' @family extract
 #' @export
+#'
+#' @examples
+#' path <- berlin_gtfs_to_zip ()
+#' gtfs <- extract_gtfs (path)
+#' gtfs <- gtfs_timetable (gtfs, day = "Wed") # A pre-processing step to speed up queries
+#' gtfs_route (gtfs, from = "Tegel", to = "Berlin Hauptbahnhof", start_time = 12 * 3600)
 berlin_gtfs_to_zip <- function () {
     flist <- c (
         "calendar.txt",

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.021",
+  "version": "0.1.2.022",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",

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