get_vmt: Get vehicle-miles travelled

In gtfstools: General Transit Feed Specification (GTFS) Editing and Analysing Tools

Get vehicle-miles travelled

Description

Returns the vehicle-miles travelled (VMT) by each specified route_id: the length of each of its trips, counted once for every departure of the trip on every day on which its service runs. VMT can be restricted to some dates and to a time of day.

Usage

get_vmt(gtfs, route_id = NULL, date = NULL, from = NULL, to = NULL)

Arguments

gtfs	A GTFS object, as created by read_gtfs().
route_id	A character vector including the route_ids to have their VKT calculated. If NULL (the default), the function calculates the VKT of every route_id in the GTFS. route_ids not listed in trips are ignored, with a warning.
date	A Date vector (including IDate) or a character vector of dates in the "YYYYMMDD" or "YYYY-MM-DD" formats. If given, only these dates are counted. If NULL (the default), every day on which the services of the routes run is counted.
from, to	Strings in the "HH:MM:SS" format. If given (both must be), only the departures at or after from and at or before to are counted. If NULL (the default), every departure is counted.

Value

A data.table with the columns route_id, n_days (the number of counted days on which at least one counted departure of the route runs), vmt (the vehicle-miles travelled on these days) and vmt_daily_mean (vmt divided by n_days, in miles per day), sorted by route_id. Routes without any departure on the counted days (and within the time of day) are not included.

Details

The VMT is the vehicle-kilometres travelled calculated by get_vkt(), converted to international miles (1 mile = 1.609344 km). See get_vkt() for how trips, departures, days and trip lengths are counted.

See Also

get_vkt(), get_route_frequency(), get_trip_length()

Examples

data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")
gtfs <- read_gtfs(data_path)

# VMT of every route over every day of the feed's calendar
vmt <- get_vmt(gtfs)
head(vmt)

# VMT of two routes in the morning peak of a single day
get_vmt(
  gtfs,
  route_id = c("CPTM L07", "2002-10"),
  date = "2019-03-04",
  from = "07:00:00",
  to = "09:00:00"
)

gtfstools documentation built on Oct. 28, 2026, 5:13 p.m.