diff --git a/DESCRIPTION b/DESCRIPTION index cc539d04..1c9b470e 100644 --- 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 index 4b58bf73..e95134ed 100644 --- 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 index 8672fd27..2c9b0dd6 100644 --- 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 index d2c0c608..9d3afa80 100644 --- a/man/frequencies_to_stop_times.Rd +++ b/man/frequencies_to_stop_times.Rd @@ -17,6 +17,14 @@ to equivalent 'arrival_time' and 'departure_time' values in \code{stop_times}. Convert a GTFS 'frequencies' table to equivalent 'stop_times' that can be used for routing. } +\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. +} +} \seealso{ Other augment: \code{\link{gtfs_transfer_table}()}