| Type: | Package |
| Title: | General Transit Feed Specification (GTFS) Editing and AnalysingTools |
| Version: | 1.4.0 |
| Description: | Utility functions to read, manipulate, analyse and write transit feeds in the General Transit Feed Specification (GTFS) data format. |
| License: | MIT + file LICENSE |
| URL: | https://ipeagit.github.io/gtfstools/,https://github.com/ipeaGIT/gtfstools |
| BugReports: | https://github.com/ipeaGIT/gtfstools/issues |
| Depends: | R (≥ 2.10) |
| Imports: | checkmate, cli, curl, data.table, gtfsio (≥ 1.0.0),parallelly, processx, sf, sfheaders, units, utils, zip |
| Suggests: | covr, ggplot2, jsonlite, knitr, rmarkdown, testthat (≥3.0.0) |
| VignetteBuilder: | knitr |
| Config/testthat/edition: | 3 |
| Encoding: | UTF-8 |
| NeedsCompilation: | yes |
| RoxygenNote: | 7.3.2 |
| LinkingTo: | cpp11 |
| Packaged: | 2025-01-08 14:26:22 UTC; R3422553 |
| Author: | Daniel Herszenhut [aut, cre], Rafael H. M. Pereira [aut], Pedro R. Andrade [aut], Joao Bazzo [aut], Mark Padgham [ctb], Marcus Saraiva [ctb], Ipea - Institute for Applied Economic Research [cph, fnd] |
| Maintainer: | Daniel Herszenhut <dhersz@gmail.com> |
| Repository: | CRAN |
| Date/Publication: | 2025-01-09 00:40:02 UTC |
gtfstools: General Transit Feed Specification (GTFS) Editing and AnalysingTools
Description
Utility functions to read, manipulate, analyse and write transit feeds in theGeneral Transit Feed Specification (GTFS) data format.
Usage
Please check the vignettes for more on the package usage:
Basic usage: reading, analysing, manipulating and writing feeds. Run
vignette("gtfstools")or check it on thewebsite.Filtering GTFS feeds. Run
vignette("filtering", package = "gtfstools")orcheck it on thewebsite.Validating GTFS feeds. Run
vignette("validating", package = "gtfstools")or check it on thewebsite.
Author(s)
Maintainer: Daniel Herszenhutdhersz@gmail.com (ORCID)
Authors:
Other contributors:
Mark Padgham [contributor]
Marcus Saraiva (ORCID) [contributor]
Ipea - Institute for Applied Economic Research [copyright holder, funder]
See Also
Useful links:
Report bugs athttps://github.com/ipeaGIT/gtfstools/issues
Coerce lists and GTFS objects from other packages into gtfstools-compatibleGTFS objects
Description
Coerces an existing object, such as alist or a GTFS object created fromother packages ({tidytransit} and{gtfsio}, for example) into agtfstools-compatible GTFS object - i.e. one whose internal tables arerepresented withdata.tables and whose fields are formatted like the fieldsof a feed read withread_gtfs().
as_dt_gtfs() is an S3 generic, with methods for:
tidygtfs: the class of GTFS objects read withtidytransit::read_gtfs().This method converts alltibbles todata.tables and convert time columns,represented ashmsobjects in atidygtfs, to strings in the"HH:MM:SS"format.gtfs: the class of GTFS objects read withgtfsio::import_gtfs(). Thismethod convert all date fields, represented asintegers in{gtfsio}'srepresentation, toDateobjects.list: this method tries to convert the elements of a list intodata.tables. Please note that all list elements must inherit fromdata.frameand must be named. This method does not try not convert fieldsto the representation used in{gtfstools}, as it does not have anyinformation on how they are formatted in the first place.
Usage
as_dt_gtfs(gtfs, ...)## S3 method for class 'tidygtfs'as_dt_gtfs(gtfs, calculate_distance = TRUE, ...)## S3 method for class 'gtfs'as_dt_gtfs(gtfs, ...)## S3 method for class 'list'as_dt_gtfs(gtfs, ...)Arguments
gtfs | The object that should be coerced to a |
... | Ignored. |
calculate_distance | A logical. Passed to |
Value
Adt_gtfs GTFS object.
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfsio_gtfs <- gtfsio::import_gtfs(data_path)class(gtfsio_gtfs)gtfstools_gtfs <- as_dt_gtfs(gtfsio_gtfs)class(gtfstools_gtfs)gtfs_like_list <- unclass(gtfsio_gtfs)class(gtfs_like_list)gtfstools_gtfs <- as_dt_gtfs(gtfs_like_list)class(gtfstools_gtfs)Convert a standards-compliant GTFS into a gtfstools' GTFS
Description
Converts a standards-compliant GTFS into a gtfstools' GTFS (i.e. one in whichdate fields are Date objects, not integers).
Usage
convert_from_standard(gtfs)Arguments
gtfs | A GTFS object, as created by |
Value
The GTFS object passed to thegtfs parameter, after converting therelevant fields.
Convert a simple feature object into ashapes table
Description
Converts aLINESTRING sf object into a GTFSshapes table.
Usage
convert_sf_to_shapes(sf_shapes, shape_id = NULL, calculate_distance = TRUE)Arguments
sf_shapes | A |
shape_id | A character vector specifying the |
calculate_distance | A logical. Whether to calculate and populate the |
Value
Adata.table representing a GTFSshapes table.
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)# first converting existing shapes table into a sf objectshapes_sf <- convert_shapes_to_sf(gtfs)head(shapes_sf)# by default converts all shapesresult <- convert_sf_to_shapes(shapes_sf)result# shape_id argument controls which shapes are convertedresult <- convert_sf_to_shapes(shapes_sf, shape_id = c("17846", "17847"))result# calculate_distance argument controls whether to calculate# shape_dist_traveled or notresult <- convert_sf_to_shapes(shapes_sf, calculate_distance = TRUE)resultConvertshapes table to simple feature object
Description
Converts theshapes table to aLINESTRING sf object.
Usage
convert_shapes_to_sf(gtfs, shape_id = NULL, crs = 4326, sort_sequence = FALSE)Arguments
gtfs | A GTFS object, as created by |
shape_id | A character vector including the |
crs | The CRS of the resulting object, either as an EPSG code or as an |
sort_sequence | A logical. Whether to sort shapes by |
Value
ALINESTRING sf object.
Examples
# read gtfsdata_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)shapes_sf <- convert_shapes_to_sf(gtfs)head(shapes_sf)shapes_sf <- convert_shapes_to_sf(gtfs, shape_id = "17846")shapes_sfConvertstops table to simple feature object
Description
Converts thestops table to aPOINT sf object.
Usage
convert_stops_to_sf(gtfs, stop_id = NULL, crs = 4326)Arguments
gtfs | A GTFS object, as created by |
stop_id | A character vector including the |
crs | The CRS of the resulting object, either as an EPSG code or as an |
Value
APOINT sf object.
Examples
# read gtfsdata_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)stops_sf <- convert_stops_to_sf(gtfs)head(stops_sf)stops_sf <- convert_stops_to_sf(gtfs, stop_id = "18848")stops_sfConvert time fields to seconds after midnight
Description
Convertsstop_times' andfrequencies' fields in the "HH:MM:SS" format toseconds after midnight. Instead of overwritting the existing fields, createsnew fields with the_secs suffix.
Usage
convert_time_to_seconds(gtfs, file = NULL, by_reference = FALSE)Arguments
gtfs | A GTFS object, as created by |
file | A character vector, specifying the file whose fields should beconverted. If |
by_reference | Whether to update the tables by reference. Defaults to |
Value
Ifby_reference isFALSE, returns a GTFS object with additionaltime in seconds columns (identified by a_secs suffix). Else, returns aGTFS object invisibly (please note that in such case the original GTFS objectis altered).
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)# by default converts both 'stop_times' and 'frequencies' timesconverted_gtfs <- convert_time_to_seconds(gtfs)head(converted_gtfs$stop_times)head(converted_gtfs$frequencies)# choose which table to convert with 'file'converted_gtfs <- convert_time_to_seconds(gtfs, file = "frequencies")head(converted_gtfs$stop_times)head(converted_gtfs$frequencies)# original gtfs remained unchanged, as seen with the frequencies table above# change original object without creating a copy with 'by_reference = TRUE'convert_time_to_seconds(gtfs, by_reference = TRUE)head(gtfs$stop_times)head(gtfs$frequencies)Convert a gtfstools' GTFS into a standards-compliant GTFS
Description
Converts a gtfstools' GTFS into a standards-compliant GTFS (i.e. date fieldsare converted from Date to integer).
Usage
convert_to_standard(gtfs)Arguments
gtfs | A GTFS object, as created by |
Value
The GTFS object passed to thegtfs parameter, after converting therelevant fields.
Make a GTFS copy with a field of a different class
Description
Creates a copy of a GTFS object while changing the class of a given field.Used for testing.
Usage
copy_gtfs_diff_field_class(gtfs, file, field, class)Arguments
gtfs | A GTFS object, as created by |
file | File whose field must have the class changed. |
field | Field to have the class changed. |
class | The desired class. |
Value
A GTFS object with the field of desired class.
Make a GTFS copy without a given field from a given file
Description
Creates a copy of a GTFS object without a given field from a given file. Usedfor testing.
Usage
copy_gtfs_without_field(gtfs, file, field)Arguments
gtfs | A GTFS object, as created by |
file | File from which the field must be removed. |
field | Field to be removed. |
Value
A GTFS object without the given field.
Make a GTFS copy without a given file
Description
Creates a copy of a GTFS object without a given file. Used for testing.
Usage
copy_gtfs_without_file(gtfs, file)Arguments
gtfs | A GTFS object, as created by |
file | File to be removed. |
Value
A GTFS object without the given file.
Convert a Date vector into an integer vector
Description
Convert a Date vector into an integer vector
Usage
date_to_integer(field)Download MobilityData's GTFS validator
Description
Downloads MobilityData's command line tool to validate GTFS feeds.
Usage
download_validator(path, version = "latest", force = FALSE, quiet = TRUE)Arguments
path | A string. The directory where the validator should be saved to. |
version | A string. The version of the validator that should bedownloaded. Defaults to |
force | A logical. Whether to overwrite a previously downloadedvalidator in |
quiet | A logical. Whether to hide log messages and progress bars.Defaults to |
Value
Invisibly returns the normalized path to the downloaded validator.
See Also
Other validation:validate_gtfs()
Examples
path <- tempdir()download_validator(path)# specifying a specific versiondownload_validator(path, version = "6.0.0")Filter GTFS object byagency_id
Description
Filters a GTFS object byagency_ids, keeping (or dropping) the relevantentries in each file.
Usage
filter_by_agency_id(gtfs, agency_id, keep = TRUE)Arguments
gtfs | A GTFS object, as created by |
agency_id | A character vector. The |
keep | A logical. Whether the entries related to the specified |
Value
The GTFS object passed to thegtfs parameter, after the filteringprocess.
See Also
Other filtering functions:filter_by_route_id(),filter_by_route_type(),filter_by_service_id(),filter_by_sf(),filter_by_shape_id(),filter_by_spatial_extent(),filter_by_stop_id(),filter_by_time_of_day(),filter_by_trip_id(),filter_by_weekday()
Examples
data_path <- system.file("extdata/ber_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)agency_id <- "92"object.size(gtfs)# keeps entries related to passed agency_idsmaller_gtfs <- filter_by_agency_id(gtfs, agency_id)object.size(smaller_gtfs)# drops entries related to passed agency_idsmaller_gtfs <- filter_by_agency_id(gtfs, agency_id, keep = FALSE)object.size(smaller_gtfs)Filter GTFS object byroute_id
Description
Filters a GTFS object byroute_ids, keeping (or dropping) the relevantentries in each file.
Usage
filter_by_route_id(gtfs, route_id, keep = TRUE)Arguments
gtfs | A GTFS object, as created by |
route_id | A character vector. The |
keep | A logical. Whether the entries related to the specified |
Value
The GTFS object passed to thegtfs parameter, after the filteringprocess.
See Also
Other filtering functions:filter_by_agency_id(),filter_by_route_type(),filter_by_service_id(),filter_by_sf(),filter_by_shape_id(),filter_by_spatial_extent(),filter_by_stop_id(),filter_by_time_of_day(),filter_by_trip_id(),filter_by_weekday()
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)route_ids <- c("6450-51", "CPTM L11")object.size(gtfs)# keeps entries related to passed route_idssmaller_gtfs <- filter_by_route_id(gtfs, route_ids)object.size(smaller_gtfs)# drops entries related to passed route_idssmaller_gtfs <- filter_by_route_id(gtfs, route_ids, keep = FALSE)object.size(smaller_gtfs)Filter GTFS object byroute_type (transport mode)
Description
Filters a GTFS object byroute_types, keeping (or dropping) the relevantentries in each file.
Usage
filter_by_route_type(gtfs, route_type, keep = TRUE)Arguments
gtfs | A GTFS object, as created by |
route_type | An integer vector. The |
keep | A logical. Whether the entries related to the specified |
Value
The GTFS object passed to thegtfs parameter, after the filteringprocess.
Route types
Valid options include the route types listed in the GTFS Schedulespecification and in the Google Transit implementation. The types specifiedin the GTFS Schedule specification are:
0 - Tram, Streetcar, Light rail. Any light rail or street level systemwithin a metropolitan area.
1 - Subway, Metro. Any underground rail system within a metropolitan area.
2 - Rail. Used for intercity or long-distance travel.
3 - Bus. Used for short- and long-distance bus routes.
4 - Ferry. Used for short- and long-distance boat service.
5 - Cable tram. Used for street-level rail cars where the cable runsbeneath the vehicle, e.g., cable car in San Francisco.
6 - Aerial lift, suspended cable car (e.g., gondola lift, aerial tramway).Cable transport where cabins, cars, gondolas or open chairs are suspended bymeans of one or more cables.
7 - Funicular. Any rail system designed for steep inclines.
11 - Trolleybus. Electric buses that draw power from overhead wires usingpoles.
12 - Monorail. Railway in which the track consists of a single rail or abeam.
The types defined in Google Transit's extension are listed below, includingsome examples (not available for all types):
100 - Railway Service - Not applicable (N/A)
101 - High Speed Rail Service - TGV (FR), ICE (DE), Eurostar (GB)
102 - Long Distance Trains - InterCity/EuroCity
103 - Inter Regional Rail Service - InterRegio (DE), Cross County Rail (GB)
104 - Car Transport Rail Service
105 - Sleeper Rail Service - GNER Sleeper (GB)
106 - Regional Rail Service - TER (FR), Regionalzug (DE)
107 - Tourist Railway Service - Romney, Hythe & Dymchurch (GB)
108 - Rail Shuttle (Within Complex) - Gatwick Shuttle (GB), Sky Line (DE)
109 - Suburban Railway - S-Bahn (DE), RER (FR), S-tog (Kopenhagen)
110 - Replacement Rail Service
111 - Special Rail Service
112 - Lorry Transport Rail Service
113 - All Rail Services
114 - Cross-Country Rail Service
115 - Vehicle Transport Rail Service
116 - Rack and Pinion Railway - Rochers de Naye (CH), Dolderbahn (CH)
117 - Additional Rail Service
200 - Coach Service
201 - International Coach Service - EuroLine, Touring
202 - National Coach Service - National Express (GB)
203 - Shuttle Coach Service - Roissy Bus (FR), Reading-Heathrow (GB)
204 - Regional Coach Service
205 - Special Coach Service
206 - Sightseeing Coach Service
207 - Tourist Coach Service
208 - Commuter Coach Service
209 - All Coach Services
400 - Urban Railway Service
401 - Metro Service - Métro de Paris
402 - Underground Service - London Underground, U-Bahn
403 - Urban Railway Service
404 - All Urban Railway Services
405 - Monorail
700 - Bus Service
701 - Regional Bus Service - Eastbourne-Maidstone (GB)
702 - Express Bus Service - X19 Wokingham-Heathrow (GB)
703 - Stopping Bus Service - 38 London: Clapton Pond-Victoria (GB)
704 - Local Bus Service
705 - Night Bus Service - N prefixed buses in London (GB)
706 - Post Bus Service - Maidstone P4 (GB)
707 - Special Needs Bus
708 - Mobility Bus Service
709 - Mobility Bus for Registered Disabled
710 - Sightseeing Bus
711 - Shuttle Bus - 747 Heathrow-Gatwick Airport Service (GB)
712 - School Bus
713 - School and Public Service Bus
714 - Rail Replacement Bus Service
715 - Demand and Response Bus Service
716 - All Bus Services
800 - Trolleybus Service
900 - Tram Service
901 - City Tram Service
902 - Local Tram Service - Munich (DE), Brussels (BE), Croydon (GB)
903 - Regional Tram Service
904 - Sightseeing Tram Service - Blackpool Seafront (GB)
905 - Shuttle Tram Service
906 - All Tram Services
1000 - Water Transport Service
1100 - Air Service
1200 - Ferry Service
1300 - Aerial Lift Service - Telefèric de Montjuïc (ES), Saleve (CH), Roosevelt Island Tramway (US)
1301 - Telecabin Service
1302 - Cable Car Service
1303 - Elevator Service
1304 - Chair Lift Service
1305 - Drag Lift Service
1306 - Small Telecabin Service
1307 - All Telecabin Services
1400 - Funicular Service - Rigiblick (Zürich, CH)
1500 - Taxi Service
1501 - Communal Taxi Service - Marshrutka (RU), dolmuş (TR)
1502 - Water Taxi Service
1503 - Rail Taxi Service
1504 - Bike Taxi Service
1505 - Licensed Taxi Service
1506 - Private Hire Service Vehicle
1507 - All Taxi Services
1700 - Miscellaneous Service
1702 - Horse-drawn Carriage
See Also
Other filtering functions:filter_by_agency_id(),filter_by_route_id(),filter_by_service_id(),filter_by_sf(),filter_by_shape_id(),filter_by_spatial_extent(),filter_by_stop_id(),filter_by_time_of_day(),filter_by_trip_id(),filter_by_weekday()
Examples
# read gtfsdata_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)object.size(gtfs)# keeps entries related to passed route_typessmaller_gtfs <- filter_by_route_type(gtfs, route_type = 1)object.size(smaller_gtfs)# drops entries related to passed route_typessmaller_gtfs <- filter_by_route_type(gtfs, route_type = 1, keep = FALSE)object.size(smaller_gtfs)Filter GTFS object byservice_id
Description
Filters a GTFS object byservice_ids, keeping (or dropping) the relevantentries in each file.
Usage
filter_by_service_id(gtfs, service_id, keep = TRUE)Arguments
gtfs | A GTFS object, as created by |
service_id | A character vector. The |
keep | A logical. Whether the entries related to the specified |
Value
The GTFS object passed to thegtfs parameter, after the filteringprocess.
See Also
Other filtering functions:filter_by_agency_id(),filter_by_route_id(),filter_by_route_type(),filter_by_sf(),filter_by_shape_id(),filter_by_spatial_extent(),filter_by_stop_id(),filter_by_time_of_day(),filter_by_trip_id(),filter_by_weekday()
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)service_ids <- c("USD", "U__")object.size(gtfs)# keeps entries related to the specified service_idssmaller_gtfs <- filter_by_service_id(gtfs, service_ids)object.size(smaller_gtfs)# drops entries related to the specified service_idssmaller_gtfs <- filter_by_service_id(gtfs, service_ids, keep = FALSE)object.size(smaller_gtfs)Filter a GTFS object using asimple features object (deprecated)
Description
This function has been deprecated as of the current package version and willbe completely removed from version 2.0.0 onward. Please usefilter_by_spatial_extent() instead.
Filters a GTFS object using the geometry of ansf object, keeping (ordropping) entries related to shapes and trips selected through a spatialoperation.
Usage
filter_by_sf(gtfs, geom, spatial_operation = sf::st_intersects, keep = TRUE)Arguments
gtfs | A GTFS object, as created by |
geom | An |
spatial_operation | A spatial operation function from the set ofoptions listed ingeos_binary_pred (check theDE-I9M Wikipedia entry for thedefinition of each function). Defaults to |
keep | A logical. Whether the entries related to the shapes and tripsthat cross through the given geometry should be kept or dropped (defaultsto |
Value
The GTFS object passed to thegtfs parameter, after the filteringprocess.
See Also
Other filtering functions:filter_by_agency_id(),filter_by_route_id(),filter_by_route_type(),filter_by_service_id(),filter_by_shape_id(),filter_by_spatial_extent(),filter_by_stop_id(),filter_by_time_of_day(),filter_by_trip_id(),filter_by_weekday()
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)shape_id <- "68962"shape_sf <- convert_shapes_to_sf(gtfs, shape_id)bbox <- sf::st_bbox(shape_sf)object.size(gtfs)# keeps entries that intersect with the specified polygonsmaller_gtfs <- filter_by_sf(gtfs, bbox)object.size(smaller_gtfs)# drops entries that intersect with the specified polygonsmaller_gtfs <- filter_by_sf(gtfs, bbox, keep = FALSE)object.size(smaller_gtfs)# uses a different function to filter the gtfssmaller_gtfs <- filter_by_sf(gtfs, bbox, spatial_operation = sf::st_contains)object.size(smaller_gtfs)Filter GTFS object byshape_id
Description
Filters a GTFS object byshape_ids, keeping (or dropping) the relevantentries in each file.
Usage
filter_by_shape_id(gtfs, shape_id, keep = TRUE)Arguments
gtfs | A GTFS object, as created by |
shape_id | A character vector. The |
keep | A logical. Whether the entries related to the specified |
Value
The GTFS object passed to thegtfs parameter, after the filteringprocess.
See Also
Other filtering functions:filter_by_agency_id(),filter_by_route_id(),filter_by_route_type(),filter_by_service_id(),filter_by_sf(),filter_by_spatial_extent(),filter_by_stop_id(),filter_by_time_of_day(),filter_by_trip_id(),filter_by_weekday()
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)shape_ids <- c("17846", "68962")object.size(gtfs)# keeps entries related to passed shape_idssmaller_gtfs <- filter_by_shape_id(gtfs, shape_ids)object.size(smaller_gtfs)# drops entries related to passed shape_idssmaller_gtfs <- filter_by_shape_id(gtfs, shape_ids, keep = FALSE)object.size(smaller_gtfs)Filter a GTFS object using a spatial extent
Description
Filters a GTFS object using a spatial extent (passed as ansf object),keeping (or dropping) entries related to shapes and trips whose geometriesare selected through a specified spatial operation.
Usage
filter_by_spatial_extent( gtfs, geom, spatial_operation = sf::st_intersects, keep = TRUE)Arguments
gtfs | A GTFS object, as created by |
geom | An |
spatial_operation | A spatial operation function from the set ofoptions listed ingeos_binary_pred (check theDE-I9M Wikipedia entry for thedefinition of each function). Defaults to |
keep | A logical. Whether the entries related to the shapes and tripsselected by the given spatial operation should be kept or dropped (defaultsto |
Value
The GTFS object passed to thegtfs parameter, after the filteringprocess.
See Also
Other filtering functions:filter_by_agency_id(),filter_by_route_id(),filter_by_route_type(),filter_by_service_id(),filter_by_sf(),filter_by_shape_id(),filter_by_stop_id(),filter_by_time_of_day(),filter_by_trip_id(),filter_by_weekday()
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)shape_id <- "68962"shape_sf <- convert_shapes_to_sf(gtfs, shape_id)bbox <- sf::st_bbox(shape_sf)object.size(gtfs)# keeps entries that intersect with the specified polygonsmaller_gtfs <- filter_by_spatial_extent(gtfs, bbox)object.size(smaller_gtfs)# drops entries that intersect with the specified polygonsmaller_gtfs <- filter_by_spatial_extent(gtfs, bbox, keep = FALSE)object.size(smaller_gtfs)# uses a different function to filter the gtfssmaller_gtfs <- filter_by_spatial_extent( gtfs, bbox, spatial_operation = sf::st_contains)object.size(smaller_gtfs)Filter GTFS object bystop_id
Description
Filters a GTFS object bystop_ids, keeping (or dropping) relevant entriesin each file.
Usage
filter_by_stop_id( gtfs, stop_id, keep = TRUE, include_children = TRUE, include_parents = keep, full_trips = TRUE)Arguments
gtfs | A GTFS object, as created by |
stop_id | A character vector. The |
keep | A logical. Whether the entries related to the |
include_children | A logical. Whether the filtered output shouldkeep/drop children stops of those specified in |
include_parents | A logical. Whether the filtered output shouldkeep/drop parent stations of those specified in |
full_trips | A logical. Whether to keep all stops that compose tripsthat pass through the stops specified in |
Value
The GTFS object passed to thegtfs parameter, after the filteringprocess.
See Also
Other filtering functions:filter_by_agency_id(),filter_by_route_id(),filter_by_route_type(),filter_by_service_id(),filter_by_sf(),filter_by_shape_id(),filter_by_spatial_extent(),filter_by_time_of_day(),filter_by_trip_id(),filter_by_weekday()
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)stop_ids <- c("18848", "940004157")object.size(gtfs)# keeps entries related to trips that pass through specified stop_idssmaller_gtfs <- filter_by_stop_id(gtfs, stop_ids, full_trips = FALSE)object.size(smaller_gtfs)# drops entries related to trips that pass through specified stop_idssmaller_gtfs <- filter_by_stop_id( gtfs, stop_ids, keep = FALSE, full_trips = FALSE)object.size(smaller_gtfs)# the old behavior of filtering trips that contained the specified stops has# been deprecatedinvisible(filter_by_stop_id(gtfs, stop_ids, full_trips = TRUE))Filter GTFS object by time of day
Description
Filters a GTFS object by time of day, keeping (or dropping) the relevantentries in each file. Please see the details section for more information onhow this function filters thefrequencies andstop_times tables, as wellas how it handlesstop_times tables that contain trips with some emptydeparture and arrival times.
Usage
filter_by_time_of_day( gtfs, from, to, keep = TRUE, full_trips = FALSE, update_frequencies = TRUE)Arguments
gtfs | A GTFS object, as created by |
from | A string. The starting point of the time of day, in the"HH:MM:SS" format. |
to | A string. The ending point of the time of day, in the "HH:MM:SS"format. |
keep | A logical. Whether the entries related to the specified time ofday should be kept or dropped (defaults to |
full_trips | A logical. Whether trips should be treated as immutableblocks or each of its stops should be considered separately when filteringthe |
update_frequencies | A logical. Whether the |
Value
The GTFS object passed to thegtfs parameter, after the filteringprocess.
Details
When filtering thefrequencies table,filter_by_time_of_day() respectstheexact_times field. This field indicates whether the service follows afixed schedule throughout the day or not. If it's 0 (or if it's notpresent), the service does not follow a fixed schedule. Instead, theoperators try to maintain the listed headways. In such cases, ifupdate_frequencies isTRUE we just updatestart_time andend_time tothe appropriate value offrom orto (which of this value is used dependsonkeep).
Ifexact_times is 1, however, operators try to strictly adhere to the starttimes and headway. As a result, when updating thestart_time field we needto follow the listed headway. For example, take a trip that has its starttime listed as 06:00:00, its end time listed as 08:00:00 and its headwaylisted as 300 secs (5 minutes). If you decide to filter the feed to keep thetime of day between 06:32:00 and 08:00:00 while updatingfrequencies, thestart_time field must be updated to 06:35:00 in order to preserve thecorrect departure times of this trips, instead of simply updating it to06:32:00.
Another things to keep an eye on when filtering thefrequencies table isthat the correspondingstop_times entries of trips listed in thefrequencies table should not be filtered, even if their departure andarrival times fall outside the specified time of day. This is because thestop_times entries offrequencies' trips are just templates that describehow long a segment between two stops takes, so the departure and arrivaltimes listed there do not actually represent the actual departure andarrival times seen in practice. Taking the same example listed above, thecorrespondingstop_times entries of that trip could describe a departurefrom the first stop at 12:00:00 and an arrival at the second stop at12:03:00. That doesn't mean the trip will actually leave and arrive at thestops at these times, but rather that it takes 3 minutes to get from thefirst to the second stop. So when the trip departs from the first stop at06:35:00, it will get to the second at 06:38:00.
When filtering thestop_times table, a few other details should beobserved. First, one could wish to filter a GTFS object in order to keep alltrips that cross a given time of day, whereas others may want to keep onlythe specific entries that fall inside the specified time of day. Forexample, take a trip that leaves the first stop at 06:30:00, gets to thesecond at 06:35:00 and then gets to the third at 06:45:00. When filtering tokeep entire trips that cross the time of day between 06:30:00 and 06:40:00,all three stops will have to be kept. If, however, you want to keep only theentries that fall within the specified time of day, only the first twoshould be kept. To control such behaviour you need to set thefull_tripsparameter. When it'sTRUE, the function behaves like the first case, andwhen it'sFALSE, like the second.
When usingfull_trips in conjunction withkeep, please note how theirbehaviour stack. When both areTRUE, trips are always fully kept. Whenkeep isFALSE, however, trips are fully dropped, even if some of theirstops are visited outside the specified time of day.
Finally, please note that many GTFS feeds may containstop_times entrieswith empty departure and arrival times. In such cases, filtering by time ofday withfull_trips asFALSE will drop the entries with empty times.Please setfull_trips toTRUE to preserve these entries.
See Also
Other filtering functions:filter_by_agency_id(),filter_by_route_id(),filter_by_route_type(),filter_by_service_id(),filter_by_sf(),filter_by_shape_id(),filter_by_spatial_extent(),filter_by_stop_id(),filter_by_trip_id(),filter_by_weekday()
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)# taking a look at the original frequencies and stop_timeshead(gtfs$frequencies)head(gtfs$stop_times)smaller_gtfs <- filter_by_time_of_day(gtfs, "05:00:00", "06:00:00")# filter_by_time_of_day filters the frequencies table but doesn't filter the# stop_times table because they're just templateshead(smaller_gtfs$frequencies)head(smaller_gtfs$stop_times)# frequencies entries can be adjusted using update_frequencies = TRUEsmaller_gtfs <- filter_by_time_of_day( gtfs, "05:30:00", "06:00:00", update_frequencies = TRUE)head(smaller_gtfs$frequencies)# when keep = FALSE, the behaviour of the function in general, and of# update_frequencies in particular, is a bit differentsmaller_gtfs <- filter_by_time_of_day( gtfs, "05:30:00", "06:00:00", keep = FALSE, update_frequencies = TRUE)head(smaller_gtfs$frequencies)# let's remove the frequencies table to check the behaviour of full_tripsgtfs$frequencies <- NULLsmaller_gtfs <- filter_by_time_of_day( gtfs, "05:30:00", "06:00:00")head(smaller_gtfs$stop_times)smaller_gtfs <- filter_by_time_of_day( gtfs, "05:30:00", "06:00:00", full_trips = TRUE)head(smaller_gtfs$stop_times)Filter GTFS object bytrip_id
Description
Filters a GTFS object bytrip_ids, keeping (or dropping) the relevantentries in each file.
Usage
filter_by_trip_id(gtfs, trip_id, keep = TRUE)Arguments
gtfs | A GTFS object, as created by |
trip_id | A character vector. The |
keep | A logical. Whether the entries related to the specified |
Value
The GTFS object passed to thegtfs parameter, after the filteringprocess.
See Also
Other filtering functions:filter_by_agency_id(),filter_by_route_id(),filter_by_route_type(),filter_by_service_id(),filter_by_sf(),filter_by_shape_id(),filter_by_spatial_extent(),filter_by_stop_id(),filter_by_time_of_day(),filter_by_weekday()
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)trip_ids <- c("CPTM L07-0", "2002-10-0")object.size(gtfs)# keeps entries related to passed trip_idssmaller_gtfs <- filter_by_trip_id(gtfs, trip_ids)object.size(smaller_gtfs)# drops entries related to passed trip_idssmaller_gtfs <- filter_by_trip_id(gtfs, trip_ids, keep = FALSE)object.size(smaller_gtfs)Filter GTFS object by weekday
Description
Filters a GTFS object by weekday, keeping (or dropping) the relevant entriesin each file.
Usage
filter_by_weekday(gtfs, weekday, combine = "or", keep = TRUE)Arguments
gtfs | A GTFS object, as created by |
weekday | A character vector. The weekdays used to filter the data.Possible values are |
combine | A string. Specifies which logic operation (OR or AND) shouldbe used to filter the calendar table when multiple weekdays are specified.Defaults to |
keep | A logical. Whether the entries related to the specified weekdaysshould be kept or dropped (defaults to |
Value
The GTFS object passed to thegtfs parameter, after the filteringprocess.
combine usage
When filtering the calendar table using weekdays, one could reason about theprocess in different ways. For example, you may want to keep only serviceswho run on mondays AND tuesdays. Or you may want to keep services that runEITHER on mondays OR on tuesdays. The first case is the equivalent offiltering using the expressionmonday == 1 & tuesday == 1, while the secondusesmonday == 1 | tuesday == 1. You can use thecombine argument tocontrol this behaviour.
Please note thatcombine also works together withkeep. Using the sameexamples listed above, you could either keep the entries related to servicesthat run on mondays and tuesdays or drop them, depending on the value youpass tokeep.
See Also
Other filtering functions:filter_by_agency_id(),filter_by_route_id(),filter_by_route_type(),filter_by_service_id(),filter_by_sf(),filter_by_shape_id(),filter_by_spatial_extent(),filter_by_stop_id(),filter_by_time_of_day(),filter_by_trip_id()
Examples
# read gtfsdata_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)object.size(gtfs)# keeps entries related to services than run EITHER on monday OR on sundaysmaller_gtfs <- filter_by_weekday(gtfs, weekday = c("monday", "sunday"))smaller_gtfs$calendar[, c("service_id", "monday", "sunday")]object.size(smaller_gtfs)# keeps entries related to services than run on monday AND on sundaysmaller_gtfs <- filter_by_weekday( gtfs, weekday = c("monday", "sunday"), combine = "and")smaller_gtfs$calendar[, c("service_id", "monday", "sunday")]object.size(smaller_gtfs)# drops entries related to services than run EITHER on monday OR on sunday# the resulting gtfs shouldn't include any trips running on these dayssmaller_gtfs <- filter_by_weekday( gtfs, weekday = c("monday", "sunday"), keep = FALSE)smaller_gtfs$calendar[, c("service_id", "monday", "sunday")]object.size(smaller_gtfs)# drops entries related to services than run on monday AND on sunday# the resulting gtfs may include trips that run on these days, but no trips# that run on both these dayssmaller_gtfs <- filter_by_weekday( gtfs, weekday = c("monday", "sunday"), combine = "and", keep = FALSE)smaller_gtfs$calendar[, c("service_id", "monday", "sunday")]object.size(smaller_gtfs)Convert frequencies to stop times
Description
Createsstop_times entries based on the frequencies specified in thefrequencies table.
Usage
frequencies_to_stop_times(gtfs, trip_id = NULL, force = FALSE)Arguments
gtfs | A GTFS object, as created by |
trip_id | A character vector including the |
force | Whether to convert trips specified in the |
Value
A GTFS object with updatedfrequencies,stop_times andtripstables.
Details
A single trip described in afrequencies table may yield multiple tripsafter converting the GTFS. Let's say, for example, that thefrequenciestable describes a trip called"example_trip", that starts at 08:00 andstops at 09:00, with a 30 minutes headway.
In practice, that means that one trip will depart at 08:00, another at 08:30and yet another at 09:00.frequencies_to_stop_times() appends a"_<n>"suffix to the newly created trips to differentiate each one of them (e.g. inthis case, the new trips, described in thetrips andstop_times tables,would be called"example_trip_1","example_trip_2" and"example_trip_3").
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)trip <- "CPTM L07-0"# converts all trips listed in the frequencies tableconverted_gtfs <- frequencies_to_stop_times(gtfs)# converts only the specified trip_idconverted_gtfs <- frequencies_to_stop_times(gtfs, trip)# how the specified trip_id was described in the frequencies tablehead(gtfs$frequencies[trip_id == trip])# the first row of each equivalent stop_times entry in the converted gtfsequivalent_stop_times <- converted_gtfs$stop_times[grepl(trip, trip_id)]equivalent_stop_times[equivalent_stop_times[, .I[1], by = trip_id]$V1]Get children stops recursively
Description
Returns the (recursive) children stops of each specifiedstop_id.Recursive in this context means it returns all children's children (i.e.first children, then children's children, and then their children, and soon).
Usage
get_children_stops(gtfs, stop_id = NULL)Arguments
gtfs | A GTFS object, as created by |
stop_id | A string vector including the |
Value
Adata.table containing thestop_ids and their children'stop_ids. If a stop doesn't have a child, its correspondentchild_identry is marked as"".
Examples
data_path <- system.file("extdata/ggl_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)children <- get_children_stops(gtfs)head(children)# use the stop_id argument to control which stops are analyzedchildren <- get_children_stops(gtfs, stop_id = c("F12S", "F12N"))childrenGet parent stations recursively
Description
Returns the (recursive) parent stations of each specifiedstop_id.Recursive in this context means it returns all parents' parents (i.e. firstparents, then parents' parents, and then their parents, and so on).
Usage
get_parent_station(gtfs, stop_id = NULL)Arguments
gtfs | A GTFS object, as created by |
stop_id | A string vector including the |
Value
Adata.table containing thestop_ids and theirparent_stations.If a stop doesn't have a parent, its correspondentparent_station entryis marked as"".
See Also
Examples
data_path <- system.file("extdata/ggl_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)parents <- get_parent_station(gtfs)head(parents)# use the stop_id argument to control which stops are analyzedparents <- get_parent_station(gtfs, c("B1", "B2"))parentsGet stop times patterns
Description
Identifies spatial and spatiotemporal patterns within thestop_timestable. Please see the details to understand what a "pattern" means in each ofthese cases.
Usage
get_stop_times_patterns( gtfs, trip_id = NULL, type = "spatial", sort_sequence = FALSE)Arguments
gtfs | A GTFS object, as created by |
trip_id | A character vector including the |
type | A string specifying the type of patterns to be analyzed. Either |
sort_sequence | A logical specifying whether to sort timetables by |
Value
Adata.table associating eachtrip_id to apattern_id.
Details
Two trips are assigned to the same spatialpattern_id if they travel alongthe same sequence of stops. They are assigned to the same spatiotemporalpattern_id, on the other hand, if they travel along the same sequence ofstops and they take the same time between stops. Please note that, in suchcase, only the time between stops is taken into account, and the time thatthe trip started is ignored (e.g. if two trips depart from stop A and followthe same sequence of stops to arrive at stop B, taking both 1 hour to do so,their spatiotemporal pattern will be considered the same, even if onedeparted at 6 am and another at 7 am). Please also note that thestop_sequence field is currently ignored - which means that two stops areconsidered to follow the same sequence if one is listed right below theother on thestop_times table (e.g. if trip X lists stops A followed bystop B withstop_sequences 1 and 2, and trip Y lists stops A followed bystop B withstop_sequences 1 and 3, they are assigned to the samepattern_id).
Examples
data_path <- system.file("extdata/ber_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)patterns <- get_stop_times_patterns(gtfs)head(patterns)# use the trip_id argument to control which trips are analyzedpatterns <- get_stop_times_patterns( gtfs, trip_id = c("143765658", "143765659", "143765660"))patterns# use the type argument to control the type of pattern analyzedpatterns <- get_stop_times_patterns( gtfs, trip_id = c("143765658", "143765659", "143765660"), type = "spatiotemporal")patternsGet trip duration
Description
Returns the duration of each specifiedtrip_id.
Usage
get_trip_duration(gtfs, trip_id = NULL, unit = "min")Arguments
gtfs | A GTFS object, as created by |
trip_id | A string vector including the |
unit | A string representing the time unit in which the duration isdesired. One of |
Value
Adata.table containing the duration of each specified trip.
Details
The duration of a trip is defined as the time difference between its lastarrival time and its first departure time, as specified in thestop_timestable.
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)trip_duration <- get_trip_duration(gtfs)head(trip_duration)trip_ids <- c("CPTM L07-0", "2002-10-0")trip_duration <- get_trip_duration(gtfs, trip_id = trip_ids)trip_durationtrip_duration <- get_trip_duration(gtfs, trip_id = trip_ids, unit = "h")trip_durationGet trip geometry
Description
Returns the geometry of each specifiedtrip_id, based either on theshapes or thestop_times file (or both).
Usage
get_trip_geometry( gtfs, trip_id = NULL, file = NULL, crs = 4326, sort_sequence = FALSE)Arguments
gtfs | A GTFS object, as created by |
trip_id | A character vector including the |
file | A character vector specifying the file from which geometriesshould be generated (either one of or both |
crs | The CRS of the resulting object, either as an EPSG code or as an |
sort_sequence | A logical specifying whether to sort shapes andtimetables by |
Value
ALINESTRING sf.
Details
The geometry generation works differently for the two files. In the case ofshapes, the shape as described in the text file is converted to ansfobject. Forstop_times the geometry is the result of linking subsequentstops along a straight line (stops' coordinates are retrieved from thestops file). Thus, the resolution of the geometry when generated withshapes tends to be much higher than when created withstop_times.
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)trip_geometry <- get_trip_geometry(gtfs)head(trip_geometry)# the above is identical totrip_geometry <- get_trip_geometry(gtfs, file = c("shapes", "stop_times"))head(trip_geometry)trip_ids <- c("CPTM L07-0", "2002-10-0")trip_geometry <- get_trip_geometry(gtfs, trip_id = trip_ids)trip_geometryplot(trip_geometry["origin_file"])Get trip length
Description
Returns the length of each specifiedtrip_id, based either on theshapesor thestop_times file (or both).
Usage
get_trip_length( gtfs, trip_id = NULL, file = NULL, unit = "km", sort_sequence = FALSE)Arguments
gtfs | A GTFS object, as created by |
trip_id | A character vector including the |
file | A character vector specifying the file from which lengths shouldbe calculated (either one of or both |
unit | A string representing the unit in which lengths are desired.Either |
sort_sequence | A logical specifying whether to sort shapes andtimetables by |
Value
Adata.table containing the length of each specified trip.
Details
Please checkget_trip_geometry() documentation to understand how geometrygeneration, and consequently length calculation, differs depending on thechosen file.
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)trip_length <- get_trip_length(gtfs)head(trip_length)# the above is identical totrip_length <- get_trip_length(gtfs, file = c("shapes", "stop_times"))head(trip_length)trip_ids <- c("CPTM L07-0", "2002-10-0")trip_length <- get_trip_length(gtfs, trip_id = trip_ids)trip_lengthGet trip segments' duration
Description
Returns the duration of segments between stops of each specifiedtrip_id.
Usage
get_trip_segment_duration( gtfs, trip_id = NULL, unit = "min", sort_sequence = FALSE)Arguments
gtfs | A GTFS object, as created by |
trip_id | A string vector including the |
unit | A string representing the time unit in which the duration isdesired. One of |
sort_sequence | A logical specifying whether to sort timetables by |
Value
Adata.table containing the segments' duration of each specifiedtrip.
Details
A trip segment is defined as the path between two subsequent stops in thesame trip. The duration of a segment is defined as the time differencebetween its arrival time and its departure time, as specified in thestop_times file.
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)trip_segment_dur <- get_trip_segment_duration(gtfs)head(trip_segment_dur)# use the trip_id argument to control which trips are analyzedtrip_segment_dur <- get_trip_segment_duration(gtfs, trip_id = "CPTM L07-0")trip_segment_dur# use the unit argument to control in which unit the durations are calculatedtrip_segment_dur <- get_trip_segment_duration(gtfs, "CPTM L07-0", unit = "s")trip_segment_durGet trip speed
Description
Returns the speed of each specifiedtrip_id, based on the geometry createdfrom either theshapes or thestop_times file (or both).
Usage
get_trip_speed( gtfs, trip_id = NULL, file = "shapes", unit = "km/h", sort_sequence = FALSE)Arguments
gtfs | A GTFS object, as created by |
trip_id | A character vector including the |
file | The file from which geometries should be generated, either |
unit | A string representing the unit in which the speeds are desired.Either |
sort_sequence | Ultimately passed to |
Value
Adata.table containing the duration of each specified trip and thefile from which geometries were generated.
Details
Please checkget_trip_geometry() documentation to understand how geometrygeneration differs depending on the chosen file.
See Also
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)trip_speed <- get_trip_speed(gtfs)head(trip_speed)trip_ids <- c("CPTM L07-0", "2002-10-0")trip_speed <- get_trip_speed(gtfs, trip_ids)trip_speedtrip_speed <- get_trip_speed( gtfs, trip_ids, file = c("shapes", "stop_times"))trip_speedtrip_speed <- get_trip_speed(gtfs, trip_ids, unit = "m/s")trip_speedConvert an integer vector into a Date vector
Description
Convert an integer vector into a Date vector
Usage
integer_to_date(field)Merge GTFS files
Description
Combines many GTFS objects into a single one.
Usage
merge_gtfs(..., files = NULL, prefix = FALSE)Arguments
... | GTFS objects to be merged. Each argument can either be a GTFS ora list of GTFS objects. |
files | A character vector listing the GTFS tables to be merged. If |
prefix | Either a logical or a character vector (defaults to |
Value
A GTFS object in which each table is a combination (by row) of thetables from the specified GTFS objects.
Examples
spo_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")ggl_path <- system.file("extdata/ggl_gtfs.zip", package = "gtfstools")spo_gtfs <- read_gtfs(spo_path)names(spo_gtfs)ggl_gtfs <- read_gtfs(ggl_path)names(ggl_gtfs)merged_gtfs <- merge_gtfs(spo_gtfs, ggl_gtfs)names(merged_gtfs)# use a list() to programatically merge many GTFS objectsgtfs_list <- list(spo_gtfs, ggl_gtfs)merged_gtfs <- merge_gtfs(gtfs_list)# 'prefix' helps disambiguating from which GTFS each id comes from.# if TRUE, the ids range from 1:n, where n is the number of gtfsmerged_gtfs <- merge_gtfs(gtfs_list, prefix = TRUE)merged_gtfs$agency# if a character vector, its elements will be used to identify the each gtfsmerged_gtfs <- merge_gtfs(gtfs_list, prefix = c("spo", "ggl"))merged_gtfs$agencyRead GTFS files
Description
Reads GTFS text files from either a local.zip file or an URL.
Usage
read_gtfs( path, files = NULL, fields = NULL, skip = NULL, quiet = TRUE, encoding = "unknown")Arguments
path | The path to a GTFS |
files | A character vector containing the text files to be read from theGTFS (without the |
fields | A named list containing the fields to be read from each textfile, in the format |
skip | A character vector containing the text files that should not beread from the GTFS, without the |
quiet | Whether to hide log messages and progress bars (defaults to |
encoding | A string, ultimately passed to |
Value
Adata.table-based GTFS object: alist ofdata.tables in whicheach table represents a GTFS text file.
Details
The column types of eachdata.table in the final GTFS object conform asclosely as possible to theGoogle's Static GTFS Reference. Exceptions aredate-related columns (such ascalendar.txt'sstart_date andend_date,for example), which are converted toDate objects, instead of being kept asintegers, allowing for easier data manipulation. These columns areconverted back tointegers when writing the GTFS object to a.zip fileusingwrite_gtfs().
See Also
Other io functions:write_gtfs()
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)names(gtfs)gtfs <- read_gtfs(data_path, files = c("trips", "stop_times"))names(gtfs)gtfs <- read_gtfs(data_path, skip = "trips")names(gtfs)gtfs <- read_gtfs(data_path, fields = list(agency = "agency_id"))names(gtfs)names(gtfs$agency)Remove duplicated entries
Description
Removes duplicated entries from GTFS objects tables.
Usage
remove_duplicates(gtfs)Arguments
gtfs | A GTFS object, as created by |
Value
A GTFS object containing only unique entries.
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)# this gtfs includes some duplicated entriesgtfs$agencygtfs <- remove_duplicates(gtfs)gtfs$agencyConvert seconds after midnight to time string
Description
Converts seconds after midnight as integers to strings in the "HH:MM:SS"format.
Usage
seconds_to_string(seconds)Arguments
seconds | An integer. |
Value
A time-representing string.
Set trip average speed
Description
Sets the average speed of each specifiedtrip_id by changing thearrival_time anddeparture_time columns instop_times.
Usage
set_trip_speed(gtfs, trip_id, speed, unit = "km/h", by_reference = FALSE)Arguments
gtfs | A GTFS object, as created by |
trip_id | A string vector including the |
speed | A numeric representing the speed to be set. Its length musteither equal 1, in which case the value is recycled for all |
unit | A string representing the unit in which the speed is given. Oneof |
by_reference | Whether to update |
Value
Ifby_reference is set toFALSE, returns a GTFS object with thetime columns of itsstop_times adjusted. Else, returns a GTFS objectinvisibly (note that in this case the original GTFS object is altered).
Details
The average speed is calculated as the difference between the arrival timeat the last stop minus the departure time at the first top, over the trip'slength (as calculated viaget_trip_geometry(), based on theshapesfile). The arrival and departure times at all other stops (i.e. not thefirst neither the last) are set as"", which is written asNA withwrite_gtfs(). Some transport routing software, such asOpenTripPlanner, support specifying stoptimes like so. In such cases, they estimate arrival/departure times at theothers stops based on the average speed as well. We plan to add that featureto this function in the future.
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)gtfs_new_speed <- set_trip_speed(gtfs, trip_id = "CPTM L07-0", 50)gtfs_new_speed$stop_times[trip_id == "CPTM L07-0"]# use the unit argument to change the speed unitgtfs_new_speed <- set_trip_speed( gtfs, trip_id = "CPTM L07-0", speed = 15, unit = "m/s")gtfs_new_speed$stop_times[trip_id == "CPTM L07-0"]# original gtfs remains unchangedgtfs$stop_times[trip_id == "CPTM L07-0"]# when doing by reference, original gtfs is changedset_trip_speed(gtfs, trip_id = "CPTM L07-0", 50, by_reference = TRUE)gtfs$stop_times[trip_id == "CPTM L07-0"]Convert time string to seconds after midnight
Description
Converts strings in the "HH:MM:SS" format to seconds after midnight.
Usage
string_to_seconds(string)Arguments
string | A string in "HH:MM:SS" format. |
Value
The seconds after midnight of a given time string as an integer.
Validate GTFS feed
Description
Uses MobilityData'sGTFS validator to perform a GTFSbusiness rule validation. The results are available as an HTML report (ifvalidator v3.1.0 or higher is used) and in JSON format. Please check thecomplete set of rules used in the validationhere.Please note that this function requires a working installation of Java 11 orhigher to work.
Usage
validate_gtfs( gtfs, output_path, validator_path, overwrite = TRUE, html_preview = TRUE, pretty_json = FALSE, quiet = TRUE, n_threads = 1)Arguments
gtfs | The GTFS to be validated. Can be in the format of a GTFS object,of a path to a GTFS file, of a path to a directory or an URL to a feed. |
output_path | A string. The path to the directory that the validatorwill create and in which the results will be saved to. |
validator_path | A string. The path to the GTFS validator, previouslydownloaded with |
overwrite | A logical. Whether to overwrite existing validation resultsin |
html_preview | A logical. Whether to show HTML report in a viewer, suchas RStudio or a browser. Defaults to |
pretty_json | A logical. Whether JSON results should be printed in areadable way, that allows it to be inspected without manually formatting.Defaults to |
quiet | A logical. Whether to hide informative messages. Defaults to |
n_threads | An integer between 1 and the number of cores in the runningmachine. Control how many threads are used during the validation. Defaultsto using all but one of the available cores. |
Value
Invisibly returns the normalized path to the directory where thevalidation results were saved to.
See Also
Other validation:download_validator()
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")output_path <- tempfile("validation_result")validator_path <- download_validator(tempdir())gtfs <- read_gtfs(data_path)validate_gtfs(gtfs, output_path, validator_path)list.files(output_path)# works with feeds saved to disknew_output_path <- tempfile("new_validation_result")validate_gtfs(data_path, new_output_path, validator_path)list.files(new_output_path)# and with feeds pointed by an urlnewer_output_path <- tempfile("newer_validation_result")gtfs_url <- "https://github.com/ipeaGIT/gtfstools/raw/main/inst/extdata/spo_gtfs.zip"validate_gtfs(gtfs_url, newer_output_path, validator_path)list.files(newer_output_path)Write GTFS files
Description
Writes GTFS objects as GTFS.zip files.
Usage
write_gtfs( gtfs, path, files = NULL, standard_only = FALSE, as_dir = FALSE, overwrite = TRUE, quiet = TRUE)Arguments
gtfs | A GTFS object, as created by |
path | The path to the |
files | A character vector containing the name of the elements to bewritten to the feed. If |
standard_only | Whether to write only standard files and fields(defaults to |
as_dir | Whether to write the feed as a directory, instead of a |
overwrite | Whether to overwrite existing |
quiet | Whether to hide log messages and progress bars (defaults to |
Value
Invisibly returns the same GTFS object passed to thegtfsparameter.
See Also
Other io functions:read_gtfs()
Examples
data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")gtfs <- read_gtfs(data_path)tmp_dir <- file.path(tempdir(), "tmpdir")dir.create(tmp_dir)list.files(tmp_dir) #'tmp_file <- tempfile(pattern = "gtfs", tmpdir = tmp_dir, fileext = ".zip")write_gtfs(gtfs, tmp_file)list.files(tmp_dir)gtfs_all_files <- read_gtfs(tmp_file)names(gtfs_all_files)write_gtfs(gtfs, tmp_file, files = "stop_times")gtfs_stop_times <- read_gtfs(tmp_file)names(gtfs_stop_times)