Skip to content

Commit

Permalink
v1.0.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
dhersz committed Nov 6, 2021
1 parent adda9ec commit 8df8a9b
Show file tree
Hide file tree
Showing 7 changed files with 86 additions and 54 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Type: Package
Package: gtfsio
Title: Read and Write General Transit Feed Specification (GTFS) Files
Version: 0.2.0.9021
Version: 1.0.0
Authors@R:
c(person(given = "Daniel",
family = "Herszenhut",
Expand Down
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# gtfsio (development version)
# gtfsio 1.0.0

## Bug fixes

Expand Down
5 changes: 3 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,12 @@ knitr::opts_chunk$set(
# 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://codecov.io/gh/r-transit/gtfsio?branch=master)
[![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)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5337518.svg)](https://zenodo.org/record/5337518)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5650829.svg)](https://zenodo.org/record/5650829)

**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.

Expand Down
56 changes: 26 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,17 @@

[![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://codecov.io/gh/r-transit/gtfsio?branch=master)
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)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5337518.svg)](https://zenodo.org/record/5337518)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5650829.svg)](https://zenodo.org/record/5650829)

**gtfsio** offers tools for the development of GTFS-related packages. It
establishes a standard for representing GTFS feeds using R data types
Expand Down Expand Up @@ -52,12 +54,11 @@ path <- system.file("extdata/ggl_gtfs.zip", package = "gtfsio")
gtfs <- import_gtfs(path)

names(gtfs)
#> [1] "calendar_dates" "fare_attributes" "fare_rules"
#> [4] "feed_info" "frequencies" "levels"
#> [7] "pathways" "routes" "shapes"
#> [10] "stop_times" "stops" "transfers"
#> [13] "translations" "trips" "agency"
#> [16] "attributions" "calendar"
#> [1] "calendar_dates" "fare_attributes" "fare_rules" "feed_info"
#> [5] "frequencies" "levels" "pathways" "routes"
#> [9] "shapes" "stop_times" "stops" "transfers"
#> [13] "translations" "trips" "agency" "attributions"
#> [17] "calendar"
```

`import_gtfs()` returns a `gtfs` object. The `gtfs` class might be
Expand All @@ -77,26 +78,23 @@ tmpf <- tempfile(fileext = ".zip")
export_gtfs(gtfs, tmpf)

zip::zip_list(tmpf)$filename
#> [1] "calendar_dates.txt" "fare_attributes.txt"
#> [3] "fare_rules.txt" "feed_info.txt"
#> [5] "frequencies.txt" "levels.txt"
#> [7] "pathways.txt" "routes.txt"
#> [9] "shapes.txt" "stop_times.txt"
#> [11] "stops.txt" "transfers.txt"
#> [13] "translations.txt" "trips.txt"
#> [15] "agency.txt" "attributions.txt"
#> [17] "calendar.txt"
#> [1] "calendar_dates.txt" "fare_attributes.txt" "fare_rules.txt"
#> [4] "feed_info.txt" "frequencies.txt" "levels.txt"
#> [7] "pathways.txt" "routes.txt" "shapes.txt"
#> [10] "stop_times.txt" "stops.txt" "transfers.txt"
#> [13] "translations.txt" "trips.txt" "agency.txt"
#> [16] "attributions.txt" "calendar.txt"
```

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/ATFutures/gtfs-router)
- [`{gtfstools}`](https://github.com/ipeaGIT/gtfstools)
- [`{tidytransit}`](https://github.com/r-transit/tidytransit)
- [`{gtfs2gps}`](https://github.com/ipeaGIT/gtfs2gps)
- [`{gtfsrouter}`](https://github.com/ATFutures/gtfs-router)
- [`{gtfstools}`](https://github.com/ipeaGIT/gtfstools)

## Citation

Expand All @@ -105,22 +103,20 @@ citation("gtfsio")
#>
#> To cite gtfsio in publications use:
#>
#> Daniel Herszenhut, Flavio Poletti & Mark Padgham.
#> (2021, August). gtfsio: Read and Write General
#> Transit Feed Specification (GTFS) Files (Version
#> v0.2.0). Zenodo.
#> http://doi.org/10.5281/zenodo.5337518
#> Daniel Herszenhut, Flavio Poletti & Mark Padgham. (2021, November).
#> gtfsio: Read and Write General Transit Feed Specification (GTFS)
#> Files (Version v1.0.0). Zenodo. http://doi.org/10.5281/zenodo.5650829
#>
#> A BibTeX entry for LaTeX users is
#>
#> @Manual{,
#> title = {gtfsio: Read and Write General Transit Feed Specification (GTFS) Files},
#> author = {Daniel Herszenhut and Flavio Poletti and Mark Padgham},
#> month = {aug},
#> month = {nov},
#> year = {2021},
#> publisher = {Zenodo},
#> version = {v0.2.0},
#> doi = {10.5281/zenodo.5337518},
#> url = {https://doi.org/10.5281/zenodo.5337518},
#> version = {v1.0.0},
#> doi = {10.5281/zenodo.5650829},
#> url = {https://doi.org/10.5281/zenodo.5650829},
#> }
```
14 changes: 7 additions & 7 deletions codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"codeRepository": "https://github.com/r-transit/gtfsio",
"issueTracker": "https://github.com/r-transit/gtfsio/issues",
"license": "https://spdx.org/licenses/MIT",
"version": "0.2.0.9021",
"version": "1.0.0",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
Expand Down Expand Up @@ -129,13 +129,13 @@
"sameAs": "https://CRAN.R-project.org/package=zip"
}
],
"fileSize": "385674.336KB",
"fileSize": "104490.739KB",
"keywords": [
"r",
"gtfs"
],
"releaseNotes": "https://github.com/r-transit/gtfsio/blob/master/NEWS.md",
"contIntegration": "https://codecov.io/gh/r-transit/gtfsio?branch=master",
"contIntegration": "https://app.codecov.io/gh/r-transit/gtfsio?branch=master",
"developmentStatus": "https://lifecycle.r-lib.org/articles/stages.html",
"relatedLink": [
"https://r-transit.github.io/gtfsio/",
Expand Down Expand Up @@ -169,10 +169,10 @@
}
],
"name": "gtfsio: Read and Write General Transit Feed Specification (GTFS) Files",
"identifier": "10.5281/zenodo.5337518",
"url": "https://doi.org/10.5281/zenodo.5337518",
"@id": "https://doi.org/10.5281/zenodo.5337518",
"sameAs": "https://doi.org/10.5281/zenodo.5337518"
"identifier": "10.5281/zenodo.5650829",
"url": "https://doi.org/10.5281/zenodo.5650829",
"@id": "https://doi.org/10.5281/zenodo.5650829",
"sameAs": "https://doi.org/10.5281/zenodo.5650829"
}
],
"readme": "https://github.com/r-transit/gtfsio/blob/master/README.md"
Expand Down
51 changes: 43 additions & 8 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Test environments

- Local Ubuntu 20.04 installation (R 4.1.1)
- Local Ubuntu 20.04 installation (R 4.1.2)
- GitHub Actions:
- Windows (release, oldrel)
- MacOS (release, oldrel)
Expand All @@ -9,25 +9,60 @@
- r-hub:
- Ubuntu Linux 20.04.1 LTS, R-release, GCC
- Fedora Linux, R-devel, clang, gfortran
- Windows Server 2008 R2 SP1, R-devel, 32/64 bit
- Oracle Solaris 10, x86, 32 bit, R-release

## R CMD check results

0 errors | 0 warnings | 0 notes
0 errors | 0 warnings | 1 note

> Found the following (possibly) invalid URLs:
> URL: https://doi.org/10.5281/zenodo.5650829
> From: inst/CITATION
> Status: 404
> Message: Not Found
> URL: https://zenodo.org/record/5650829
> From: README.md
> Status: 404
> Message: Not Found
>
> Found the following (possibly) invalid DOIs:
> DOI: 10.5281/zenodo.5650829
> From: inst/CITATION
> Status: Not Found
> Message: 404
I have reserved a DOI in Zenodo to use in the CITATION file, but I haven't yet finished the submission because I'm awaiting for the approval on CRAN to upload the package `.tar.gz`. As soon as the package gets approved I'll upload the file and finish the submission, thus creating the DOI for good and getting rid of this note.

## Reverse dependencies

Check status summary:
WARN NOTE
Source packages 0 1
Reverse depends 2 0

Check results summary:
gtfsio ... NOTE
* checking CRAN incoming feasibility ... NOTE
rdepends_gtfs2gps ... WARN
* checking CRAN incoming feasibility ... WARNING
* checking examples ... NOTE
rdepends_tidytransit ... WARN
* checking CRAN incoming feasibility ... WARNING
* checking installed package size ... NOTE

None of the notes and warnings in {gtfs2gps} and {tidytransit} checks are related to {gtfsio}. The revdep checks were run with tools::check_packages_in_dir(check_args = "--as-cran"), thus raising an "insufficient package version" warning in the dependencies check. {gtfsio}'s note is explained above.

These are the results without the --as-cran flag:

NOTE OK
Source packages 2 1
Source packages 0 1
Reverse depends 1 1

Check results summary:
gtfs2gps ... NOTE
* checking dependencies in R code ... NOTE
gtfsio ... OK
tidytransit ... NOTE
rdepends_gtfs2gps ... OK
rdepends_tidytransit ... NOTE
* checking installed package size ... NOTE
* checking dependencies in R code ... NOTE
* checking data for non-ASCII characters ... NOTE

None of the notes in {gtfs2gps} and {tidytransit} checks are related to {gtfsio}.
10 changes: 5 additions & 5 deletions inst/CITATION
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ citEntry(
entry = "Manual",
title = "gtfsio: Read and Write General Transit Feed Specification (GTFS) Files",
author = personList(as.person("Daniel Herszenhut"), as.person("Flavio Poletti"), as.person("Mark Padgham")),
month = "aug",
month = "nov",
year = 2021,
publisher = "Zenodo",
version = "v0.2.0",
doi = "10.5281/zenodo.5337518",
url = "https://doi.org/10.5281/zenodo.5337518",
textVersion = "Daniel Herszenhut, Flavio Poletti & Mark Padgham. (2021, August). gtfsio: Read and Write General Transit Feed Specification (GTFS) Files (Version v0.2.0). Zenodo. http://doi.org/10.5281/zenodo.5337518"
version = "v1.0.0",
doi = "10.5281/zenodo.5650829",
url = "https://doi.org/10.5281/zenodo.5650829",
textVersion = "Daniel Herszenhut, Flavio Poletti & Mark Padgham. (2021, November). gtfsio: Read and Write General Transit Feed Specification (GTFS) Files (Version v1.0.0). Zenodo. http://doi.org/10.5281/zenodo.5650829"
)

0 comments on commit 8df8a9b

Please sign in to comment.