Information for a given route

route_information(
  route_id,
  include_geopath = FALSE,
  geopath_utc = NULL,
  user_id = determine_user_id(),
  api_key = determine_api_key()
)

Arguments

route_id	Integer. These can be listed and described with the `routes` function.
include_geopath	Logical. Whether to populate the `geopath` column. Defaults to FALSE.
geopath_utc	Date, or character that can be converted to a date. The UTC date for which the geopaths are effective. Defaults to the current date. Has no effect if `include_geopath = FALSE`. It's uncertain how much historical or future-dated data is available.
user_id	Integer or character. A user ID or devid provided by Public Transport Victoria. Refer to `?ptvapi` for more details.
api_key	Character. An API key, with dashes, provided by Public Transport Victoria. Refer to `?ptvapi` for more details.

Value

A tibble of routes, with the following columns:

route_id
route_gtfs_id
route_name
route_type
route_type_description
route_number
geopath
service_status
service_status_timestamp

Examples

if (FALSE) {
route_information(6)
route_information(6, include_geopath = TRUE)
route_information(6, include_geopath = TRUE, geopath_utc = "2020-07-01")
}