https://github.com/r-transit/gtfsio

Read and Write General Transit Feed Specification (GTFS)
https://github.com/r-transit/gtfsio

gtfs r

Last synced: 8 days ago
JSON representation

Read and Write General Transit Feed Specification (GTFS)

• Host: GitHub
• URL: https://github.com/r-transit/gtfsio
• Owner: r-transit
• License: other
• Created: 2021-02-22T21:22:12.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-14T12:08:41.000Z (3 months ago)
• Last Synced: 2024-12-17T20:22:27.284Z (17 days ago)
• Topics: gtfs, r
• Language: R
• Homepage: https://r-transit.github.io/gtfsio/
• Size: 783 KB
• Stars: 14
• Watchers: 5
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • License: LICENSE
  • Codemeta: codemeta.json

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# gtfsio  

[![CRAN status](https://www.r-pkg.org/badges/version/gtfsio)](https://CRAN.R-project.org/package=gtfsio)

[![gtfsio status badge](https://dhersz.r-universe.dev/badges/gtfsio)](https://dhersz.r-universe.dev)

[![B status](https://github.com/r-transit/gtfsio/workflows/R-CMD-check/badge.svg)](https://github.com/r-transit/gtfsio/actions?query=workflow%3AR-CMD-check)

[![Codecov test coverage](https://codecov.io/gh/r-transit/gtfsio/branch/master/graph/badge.svg)](https://app.codecov.io/gh/r-transit/gtfsio?branch=master)

[![Lifecycle: maturing](https://lifecycle.r-lib.org/articles/figures/lifecycle-maturing.svg)](https://lifecycle.r-lib.org/articles/stages.html)

[![CRAN/METACRAN Total downloads](http://cranlogs.r-pkg.org/badges/grand-total/gtfsio?color=yellow)](https://CRAN.R-project.org/package=gtfsio)

**gtfsio** offers tools for the development of GTFS-related packages. It establishes a standard for representing GTFS feeds using R data types based on [Google's Static GTFS Reference](https://developers.google.com/transit/gtfs/reference). It provides fast and flexible functions to read and write GTFS feeds while sticking to this standard. It defines a basic `gtfs` class which is meant to be extended by packages that depend on it. And it also offers utility functions that support checking the structure of GTFS objects.

## Installation

Stable version:

```{r, eval = FALSE}

install.packages("gtfsio")

```

Development version:

```{r, eval = FALSE}

install.packages("gtfsio", repos = "https://dhersz.r-universe.dev")

# or

# install.packages("remotes")

remotes::install_github("r-transit/gtfsio")

```

## Usage

GTFS feeds are read using the `import_gtfs()` function:

```{r}

library(gtfsio)

path <- system.file("extdata/ggl_gtfs.zip", package = "gtfsio")

gtfs <- import_gtfs(path)

names(gtfs)

```

`import_gtfs()` returns a `gtfs` object. The `gtfs` class might be extended by other packages using the constructor, validator and methods provided by **gtfsio**:

```{r}

class(gtfs)

```

Use the `export_gtfs()` function to write GTFS objects to disk:

```{r}

tmpf <- tempfile(fileext = ".zip")

export_gtfs(gtfs, tmpf)

zip::zip_list(tmpf)$filename

```

For a more complete demonstration please read the [introductory vignette](https://r-transit.github.io/gtfsio/articles/gtfsio.html).

## GTFS-related packages

- [`{tidytransit}`](https://github.com/r-transit/tidytransit)

- [`{gtfs2gps}`](https://github.com/ipeaGIT/gtfs2gps)

- [`{gtfsrouter}`](https://github.com/UrbanAnalyst/gtfsrouter)

- [`{gtfstools}`](https://github.com/ipeaGIT/gtfstools)