Skip to contents

Get network routes extension

Source: R/get_network_extension.R
get_network_extension.Rd

Get total extension of GTFS feed routes

Usage

get_network_extension(
  gtfs,
  route_identifier = "route_id",
  direction_wise = TRUE,
  unified = FALSE,
  date = GTFShift::calendar_nextBusinessWednesday(),
  use_osm_routes = NA,
  metric_crs = 3857
)

Arguments

gtfs

tidygtfs. GTFS feed.

route_identifier

String. (Default "route_id"). routes.txt attribute that identifies routes. Accepted values: route_id, route_short_name, route_long_name.

direction_wise

Boolean (Default TRUE). If TRUE, extension considers sum of both directions. Otherwise, only one direction is considered.

unified

Boolean (Default FALSE). If TRUE, overlapping route segments are only counted once in the total extension.

date

Date (Default GTFShift::calendar_nextBusinessWednesday()). Reference date to consider when analyzing the GTFS file.

use_osm_routes

osmdata::opq (Default NA). If overpass query for transit network is defined, analysis is performed considering OSM route geometry, using GTFShift::osm_shapes_to_routes.

metric_crs

Integer or character (Default 3857). Projected CRS used to compute route lengths in meters.

Value

Numeric. The routes extension, in meters.

Details

This method calculates the sum of the GTFS feed routes length, considering, for each, the shape of the variant with the highest frequency for the given date (using GTFShift::get_route_frequency_hourly()). For a detailed example, see the vignette("analyse").

See also

GTFShift::get_route_frequency_hourly()

Examples

# Load GTFS
gtfs <- GTFShift::load_feed(system.file("extdata/samples",
  "gtfs_tcb_sample.zip",
  package = "GTFShift"
))

# Get route extension
GTFShift::get_network_extension(
  gtfs,
  metric_crs = 3763, # Make sure to addapt to the projection that better suits your location
  date = gtfs$calendar$start_date[1]
)
#> Analysing GTFS for 2026-06-10...
#> > Filtering by reference date 2026-06-10...
#> 71910.56 [m]