gtfs-router

An R package for routing with GTFS (General Transit Feed Specification) data.
https://github.com/UrbanAnalyst/gtfsrouter

Category: Consumption
Sub Category: Mobility and Transportation

Keywords

gtfs gtfsrouter public-transportation r-package router

Keywords from Contributors

public-transport transit-data public tidyverse transportation routes

Last synced: about 5 hours ago
JSON representation

Repository metadata

Routing and analysis engine for GTFS (General Transit Feed Specification) data

README.Rmd

          
# gtfsrouter 

[![R build
status](https://github.com/UrbanAnalyst/gtfsrouter/workflows/R-CMD-check/badge.svg)](https://github.com/UrbanAnalyst/gtfsrouter/actions?query=workflow%3AR-CMD-check)
[![codecov](https://codecov.io/gh/UrbanAnalyst/gtfsrouter/branch/main/graph/badge.svg)](https://app.codecov.io/gh/UrbanAnalyst/gtfsrouter)
[![Project Status: Active](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/gtfsrouter)](https://cran.r-project.org/package=gtfsrouter) 
[![CRAN Downloads](http://cranlogs.r-pkg.org/badges/grand-total/gtfsrouter?color=orange)](https://cran.r-project.org/package=gtfsrouter)


**R** package for public transport routing with [GTFS (General Transit Feed
Specification)](https://developers.google.com/transit/gtfs/) data.

## Installation

You can install latest stable version of `gtfsrouter` from CRAN with:
```{r cran-installation, eval = FALSE}
install.packages ("gtfsrouter")
```

Alternatively, the current development version can be installed using any of
the following options:

```{r gh-installation, eval = FALSE}
# install.packages("remotes")
remotes::install_git ("https://git.sr.ht/~mpadge/gtfsrouter")
remotes::install_git ("https://codeberg.org/UrbanAnalyst/gtfsrouter")
remotes::install_bitbucket ("urbananalyst/gtfsrouter")
remotes::install_gitlab ("UrbanAnalyst/gtfsrouter")
remotes::install_github ("UrbanAnalyst/gtfsrouter")
```

To load the package and check the version:
```{r pkg-version, eval=TRUE}
library (gtfsrouter)
packageVersion ("gtfsrouter")
```

## Main functions

The main functions can be demonstrated with sample data included with the
package from Berlin (the "Verkehrverbund Berlin Brandenburg", or VBB). GTFS
data are always stored as `.zip` files, and these sample data can be written to
the temporary directory (`tempdir()`) of the current R session with the
function `berlin_gtfs_to_zip()`.

```{r create-zip, eval = TRUE}
filename <- berlin_gtfs_to_zip ()
print (filename)
```

For normal package use, `filename` will specify the name of a local GTFS `.zip`
file. 

### gtfs_route

Given the name of a GTFS `.zip` file, `filename`, routing is as simple as the
following code:

```{r example-echo, echo = TRUE, eval = FALSE}
gtfs <- extract_gtfs (filename)
gtfs <- gtfs_timetable (gtfs, day = "Wed") # A pre-processing step to speed up queries
gtfs_route (gtfs,
    from = "Tegel",
    to = "Berlin Hauptbahnhof",
    start_time = 12 * 3600 + 120
) # 12:02 in seconds
```
```{r example, echo = FALSE, message = FALSE}
gtfs <- extract_gtfs (filename)
gtfs <- gtfs_timetable (gtfs)
r <- gtfs_route (gtfs,
    from = "Schonlein",
    to = "Berlin Hauptbahnhof",
    start_time = 12 * 3600 + 120
) # 12:02 in seconds
knitr::kable (r)
```

### gtfs_traveltimes

The [`gtfs_traveltimes()`
function`](https://UrbanAnalyst.github.io/gtfsrouter/reference/gtfs_traveltimes.html)
calculates minimal travel times from any nominated stop to all other stops
within a feed. It requires the two parameters of start station, and a vector of
two values specifying earliest and latest desired start times. The following
code returns the fastest travel times to all stations within the feed for
services which leave the nominated station ("Alexanderplatz") between 12:00 and
13:00 on a Monday:

```{r isochrone, eval = TRUE, message = FALSE}
gtfs <- extract_gtfs (filename)
gtfs <- gtfs_timetable (gtfs, day = "Monday")
x <- gtfs_traveltimes (gtfs,
    from = "Alexanderplatz",
    start_time_limits = c (12, 13) * 3600
)
```

The function returns a simple table detailing all stations reachable with
services departing from the nominated station and start times:

```{r iso-results1-fakey, eval = FALSE}
head (x)
```
```{r iso-results1, eval = TRUE, echo = FALSE}
knitr::kable (head (x))
```

Further details are provided in a [separate
vignette](https://UrbanAnalyst.github.io/gtfsrouter/articles/traveltimes.html).

### gtfs_transfer_table

Feeds should include a "transfers.txt" table detailing all possible transfers
between nearby stations, yet many feeds omit these tables, rendering them
unusable for routing because transfers between services can not be calculated.
The `gtfsrouter` package also includes a function,
[`gtfs_transfer_table()`](https://UrbanAnalyst.github.io/gtfsrouter/reference/gtfs_transfer_table.html),
which can calculate a transfer table for a given feed, with transfer times
calculated either using straight-line distances (the default), or using more
realistic pedestrian times routed through the underlying street network.

This function can also be used to enable routing through multiple adjacent or
overlapping GTFS feeds. The feeds need simply be merged through binding the
rows of all tables, and the resultant aggregate feed submitted to the
[`gtfs_transfer_table()`](https://UrbanAnalyst.github.io/gtfsrouter/reference/gtfs_transfer_table.html)
function. This transfer table will retain all transfers specified in the
original feeds, yet be augmented by all possible transfers between the multiple
systems up to a user-specified maximal distance. Further details of this
function are also provided in another [separate
vignette](https://UrbanAnalyst.github.io/gtfsrouter/articles/transfers.html).



## Additional Functionality

There are many ways to construct GTFS feeds. For background information, see
[`gtfs.org`](https://gtfs.org), and particularly their [GTFS
Examples](https://docs.google.com/document/d/16inL5BVcM1aU-_DcFJay_tC6Ni0wPa0nvQEstueG5k4/edit).
Feeds may include a "frequencies.txt" table which defines "service periods",
and overrides any schedule information during the specified times. The
`gtfsrouter` package includes a function,
[`frequencies_to_stop_times()`](https://UrbanAnalyst.github.io/gtfsrouter/reference/frequencies_to_stop_times.html),
to convert "frequencies.txt" tables to equivalent "stop_times.txt" entries, to
enable the feed to be used for routing.


## Contributors














All contributions to this project are gratefully acknowledged using the [`allcontributors` package](https://github.com/ropensci/allcontributors) following the [all-contributors](https://allcontributors.org) specification. Contributions of any kind are welcome!

### Code


mpadge

AlexandraKapp

stmarcin

dhersz

polettif
### Issue Authors

sridharraman

orlandombaa

Maxime2506

chinhqho

federicotallis

rafapereirabr

dcooley

bernd886

stefan-overkamp

luukvdmeer

szaboildi

cseveren

jh0ker

zamirD123

viajerus

jmertic

5balls

pteridin

FlxPo
### Issue Contributors

tbuckl

tuesd4y

Robinlovelace

loanho23

abyrd

hansmib

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 1 day ago

Total Commits: 897
Total Committers: 5
Avg Commits per committer: 179.4
Development Distribution Score (DDS): 0.033

Commits in past year: 23
Committers in past year: 1
Avg Commits per committer in past year: 23.0
Development Distribution Score (DDS) in past year: 0.0

Name Email Commits
mpadge m****m@e****m 867
AlexandraKapp a****2@g****m 24
Marcin Stepniak s****n@g****l 4
Flavio Poletti f****i@h****h 1
Daniel Herszenhut d****z@g****m 1

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 105
Total pull requests: 15
Average time to close issues: 4 months
Average time to close pull requests: 18 days
Total issue authors: 27
Total pull request authors: 6
Average comments per issue: 3.47
Average comments per pull request: 3.0
Merged pull request: 14
Bot issues: 3
Bot pull requests: 0

Past year issues: 6
Past year pull requests: 4
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 15 days
Past year issue authors: 4
Past year pull request authors: 1
Past year average comments per issue: 2.0
Past year average comments per pull request: 0.25
Past year merged pull request: 4
Past year bot issues: 2
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/UrbanAnalyst/gtfsrouter

Top Issue Authors

  • mpadge (47)
  • AlexandraKapp (17)
  • polettif (7)
  • FlxPo (4)
  • viajerus (3)
  • github-actions[bot] (3)
  • zamirD123 (3)
  • chinhqho (2)
  • Maxime2506 (1)
  • cseveren (1)
  • loanho23 (1)
  • dhersz (1)
  • bernd886 (1)
  • Tom-NutsOne (1)
  • rafapereirabr (1)

Top Pull Request Authors

  • AlexandraKapp (6)
  • mpadge (5)
  • stmarcin (1)
  • jmertic (1)
  • polettif (1)
  • dhersz (1)

Top Issue Labels

  • must do (8)
  • enhancement (8)
  • bug (5)
  • wontfix (4)
  • documentation (1)
  • help wanted (1)
  • future stuff (1)

Top Pull Request Labels


Package metadata

proxy.golang.org: github.com/UrbanAnalyst/gtfsrouter

proxy.golang.org: github.com/urbananalyst/gtfsrouter

cran.r-project.org: gtfsrouter

Routing with 'GTFS' (General Transit Feed Specification) Data

  • Homepage: https://github.com/UrbanAnalyst/gtfsrouter
  • Documentation: http://cran.r-project.org/web/packages/gtfsrouter/gtfsrouter.pdf
  • Licenses: GPL-3
  • Latest release: 0.1.3 (published 6 months ago)
  • Last Synced: 2025-04-29T15:33:06.859Z (1 day ago)
  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 712 Last month
  • Docker Downloads: 39
  • Rankings:
    • Forks count: 4.585%
    • Stargazers count: 4.723%
    • Average: 18.926%
    • Docker downloads count: 21.807%
    • Dependent repos count: 23.802%
    • Dependent packages count: 28.642%
    • Downloads: 29.998%
  • Maintainers (1)

Dependencies

DESCRIPTION cran
  • R >= 2.10 depends
  • Rcpp >= 0.12.6 imports
  • cli * imports
  • data.table * imports
  • geodist * imports
  • methods * imports
  • digest * suggests
  • dodgr * suggests
  • dplyr * suggests
  • ggplot2 * suggests
  • here * suggests
  • hms * suggests
  • knitr * suggests
  • lubridate * suggests
  • lwgeom * suggests
  • markdown * suggests
  • pbapply * suggests
  • rmarkdown * suggests
  • testthat * suggests
.github/workflows/check-standard.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.4.1 composite
  • actions/checkout v3 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgcheck.yaml actions
  • ropensci-review-tools/pkgcheck-action main composite
.hooks/description cran

Score: 12.849950797283316