add example to 'gtfs_local' for #113

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: gtfsrouter
 Title: Routing with 'GTFS' (General Transit Feed Specification) Data
-Version: 0.1.2.027
+Version: 0.1.2.028
 Authors@R: c(
     person("Mark", "Padgham", , "[email protected]", role = c("aut", "cre")),
     person("Marcin", "Stepniak", , "[email protected]", role = "aut",

R/go_home_work.R

@@ -180,6 +180,22 @@ get_rds_name <- function (f) {
 #'
 #' @family additional
 #' @export
+#'
+#' @examples
+#' \dontrun{
+#' # For general use, please set these three variables:
+#' Sys.setenv ("gtfs_home" = "<my home station>")
+#' Sys.setenv ("gtfs_work" = "<my work station>")
+#' Sys.setenv ("gtfs_data" = "/full/path/to/gtfs.zip")
+#'
+#' # The following illustrate use with sample data bundled with package
+#' Sys.setenv ("gtfs_home" = "Tempelhof")
+#' Sys.setenv ("gtfs_work" = "Alexanderplatz")
+#' Sys.setenv ("gtfs_data" = file.path (tempdir (), "vbb.zip"))
+#' process_gtfs_local ()
+#' # next available service from current system time:
+#' go_home ()
+#' }
 process_gtfs_local <- function (expand = 2) {
 
     vars <- get_envvars ()

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