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

validate_gtfs

R Documentation

Validate GTFS feed

Description

Uses MobilityData's GTFS validator to perform a GTFS business rule validation. The results are available as an HTML report (if validator v3.1.0 or higher is used) and in JSON format. Please check the complete set of rules used in the validation here. Please note that this function requires a working installation of Java 11 or higher to work. Recent versions of the validator require Java 17 or higher.

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 validator will create and in which the results will be saved to.
`validator_path`	A string. The path to the GTFS validator, previously downloaded with `download_validator()`.
`overwrite`	A logical. Whether to overwrite existing validation results in `output_path`. Defaults to `TRUE`.
`html_preview`	A logical. Whether to show HTML report in a viewer, such as RStudio or a browser. Defaults to `TRUE` (only works on interactive sessions).
`pretty_json`	A logical. Whether JSON results should be printed in a readable way, that allows it to be inspected without manually formatting. Defaults to `FALSE`.
`quiet`	A logical. Whether to hide informative messages. Defaults to `TRUE`.
`n_threads`	An integer between 1 and the number of cores in the running machine. Control how many threads are used during the validation. Defaults to 1.

Value

Invisibly returns the normalized path to the directory where the validation results were saved to.

Examples


data_path <- system.file("extdata/spo_gtfs.zip", package = "gtfstools")
output_path <- tempfile("validation_result")
validator_path <- download_validator(tempdir())

# download_validator() returns NULL if the validator can't be downloaded
if (!is.null(validator_path)) {
  gtfs <- read_gtfs(data_path)

  validate_gtfs(gtfs, output_path, validator_path)
  print(list.files(output_path))

  # works with feeds saved to disk
  new_output_path <- tempfile("new_validation_result")
  validate_gtfs(data_path, new_output_path, validator_path)
  print(list.files(new_output_path))

  # and with feeds pointed by an url
  newer_output_path <- tempfile("newer_validation_result")
  gtfs_url <- "https://github.com/ipea/gtfstools/raw/main/inst/extdata/spo_gtfs.zip"
  validate_gtfs(gtfs_url, newer_output_path, validator_path)
  print(list.files(newer_output_path))
}

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