R/gtfsrouter-package.R

In gtfsrouter: Routing with 'GTFS' (General Transit Feed Specification) Data

#' gtfsrouter
#'
#' Routing engine for GTFS (General Transit Feed Specification) data, including
#' one-to-one and one-to-many routing routines.
#'
#' @section Main Functions:
#' \itemize{
#' \item [gtfs_route()]: Route between given start and end stations using a
#' nominated GTFS data set.
#' \item [go_home()]: Automatic routing between work and home stations specified
#' with local environmental variables
#' \item [go_to_work()]: Automatic routing between work and home stations
#' specified with local environmental variables
#' \item [gtfs_traveltimes()]: One-to-many routing from a nominated start
#' station to all stations reachable within a specified travel duration.
#' }
#'
#' @name gtfsrouter
#' @docType package
#' @family package
#' @importFrom Rcpp evalCpp
#' @useDynLib gtfsrouter, .registration = TRUE
"_PACKAGE"

#' berlin_gtfs
#'
#' Sample GTFS data from Verkehrsverbund Berlin-Brandenburg street, reduced to U
#' and S Bahn only (underground and overground trains), and between the hours of
#' 12:00-13:00. Only those components of the GTFS data necessary for routing
#' have been retained. Note that non-ASCII characters have been removed from
#' these data, so umlauts are simply removed and eszetts become "ss". The
#' package will nevertheless work with full GTFS feeds and non-ASCII (UTF-8)
#' characters.
#'
#' @name berlin_gtfs
#' @docType data
#' @family data
#' @keywords datasets
#' @format A list of five \pkg{data.table} items necessary for routing:
#' \itemize{
#' \item calendar
#' \item routes
#' \item trips
#' \item stop_times
#' \item stops
#' \item transfers
#' }
#'
#' @note Can be re-created with the script in
#' \url{https://github.com/UrbanAnalyst/gtfsrouter/blob/master/data-raw/data-script.Rmd}.
#'
#' @inherit gtfs_route return examples
NULL