gtfs_route_headway.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/route-headway.R
\name{gtfs_route_headway}
\alias{gtfs_route_headway}
\title{Route headway}
\usage{
gtfs_route_headway(
  gtfs,
  from,
  to,
  from_to_are_ids = FALSE,
  grep_fixed = TRUE,
  quiet = FALSE
)
}
\arguments{
\item{gtfs}{A set of GTFS data returned from \link{extract_gtfs} or, for more
efficient queries, pre-processed with \link{gtfs_timetable}.}

\item{from}{Names, IDs, or approximate (lon, lat) coordinates of start
stations (as \code{stop_name} or \code{stop_id} entry in the \code{stops} table, or a vector
of two numeric values). See Note.}

\item{to}{Corresponding Names, IDs, or coordinates of end station.}

\item{from_to_are_ids}{Set to \code{TRUE} to enable \code{from} and \code{to} parameter to
specify entries in \code{stop_id} rather than \code{stop_name} column of the \code{stops}
table.}

\item{grep_fixed}{If \code{FALSE}, match station names (when passed as character
string) with \code{grep(..., fixed = FALSE)}, to allow use of \code{grep} expressions.
This is useful to refine matches in cases where desired stations may match
multiple entries.}

\item{quiet}{If \code{TRUE}, display a progress bar}
}
\value{
A single vector of integer values containing headways between all
services across a single 24-hour period
}
\description{
Calculate a vector of headway values -- that is, time intervals between
consecutive services -- for all routes between two specified stations.
}
\examples{
\dontrun{
path <- berlin_gtfs_to_zip ()
gtfs <- extract_gtfs (path)
gtfs_route_headway (gtfs, from = "Tegel", to = "Berlin Hauptbahnhof")
}
}
\seealso{
Other main: 
\code{\link{gtfs_route}()},
\code{\link{gtfs_traveltimes}()}
}
\concept{main}