Skip to content

Commit

Permalink
version 0.1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
dhersz committed Apr 4, 2021
1 parent 7f22769 commit a4fcd51
Show file tree
Hide file tree
Showing 9 changed files with 65 additions and 20 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@
^README\.Rmd$
^codecov\.yml$
^cran-comments\.md$
^_pkgdown\.yml$
5 changes: 3 additions & 2 deletions 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.0.0.9036
Version: 0.1.0
Authors@R:
c(person(given = "Daniel",
family = "Herszenhut",
Expand Down Expand Up @@ -35,7 +35,8 @@ Description: Tools for the development of packages related to General
by packages that depend on it. And offers utility functions that
support checking the structure of GTFS objects.
License: MIT + file LICENSE
URL: https://github.com/r-transit/gtfsio
URL: https://r-transit.github.io/gtfsio/,
https://github.com/r-transit/gtfsio
BugReports: https://github.com/r-transit/gtfsio/issues
Imports:
data.table,
Expand Down
12 changes: 2 additions & 10 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
# gtfsio (development version)
# gtfsio 0.1.0

## New features

### Functions

- `get_gtfs_standards()` - returns the standards for reading and writing GTFS feeds with R as a named list. Each element (also a list) represents a distinct GTFS text file, and describes: whether this file is required, optional or conditionally required; the fields that compose each file, including which R data type is best suited to represent it, whether the field is required, optional or conditionally required, and which values it can assume (most relevant to GTFS `ENUM`s.
- `import_gtfs()` - imports GTFS transit feeds from either a local `.zip` file or an URL. Columns are parsed according to the standards specified in `get_gtfs_standards()`.
- `new_gtfs()` - `gtfs` objects constructor, mostly useful for package authors who may want to either create `gtfs` objects in their packages or create subclasses of the main `gtfs` class.

## Notes
- First CRAN release!
4 changes: 2 additions & 2 deletions R/import_gtfs.R
Original file line number Diff line number Diff line change
Expand Up @@ -290,8 +290,8 @@ read_files <- function(file,

if (!is.null(fields_misspec) & !identical(fields_misspec, character(0)))
stop(
"The following fields were specified in 'extra_spec' but either were not ",
"specified in 'fields' or do not exist: ",
"The following fields were specified in 'extra_spec' but either were ",
"not specified in 'fields' or do not exist: ",
paste0("'", fields_misspec, "'", collapse = ", ")
)

Expand Down
21 changes: 21 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
reference:
- title: GTFS standards
- contents:
- get_gtfs_standards
- title: Input/output
- contents:
- import_gtfs
- export_gtfs
- title: Checking
- contents:
- check_files_exist
- check_fields_exist
- check_fields_types
- title: Constructor/validator
- contents:
- new_gtfs
- assert_gtfs
- title: Methods
- contents:
- print.gtfs
- "[.gtfs"
7 changes: 4 additions & 3 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.0.0.9036",
"version": "0.1.0",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
Expand Down Expand Up @@ -143,13 +143,14 @@
"sameAs": "https://CRAN.R-project.org/package=zip"
}
],
"fileSize": "124.038KB",
"fileSize": "124.787KB",
"keywords": [
"r",
"gtfs"
],
"releaseNotes": "https://github.com/r-transit/gtfsio/blob/master/NEWS.md",
"contIntegration": "https://codecov.io/gh/r-transit/gtfsio?branch=master",
"developmentStatus": "https://lifecycle.r-lib.org/articles/stages.html",
"readme": "https://github.com/r-transit/gtfsio/blob/master/README.md"
"readme": "https://github.com/r-transit/gtfsio/blob/master/README.md",
"relatedLink": "https://r-transit.github.io/gtfsio/"
}
24 changes: 24 additions & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## Test environments

- Local Ubuntu 20.04 installation (R 4.0.5)
- GitHub Actions:
- Windows (release, oldrel)
- MacOS (release, oldrel)
- Ubuntu 20.04 (devel, release, oldrel)
- win-builder (devel, release, oldrel)
- r-hub:
- Windows Server 2008 R2 SP1, R-devel, 32/64 bit
- Ubuntu Linux 20.04.1 LTS, R-release, GCC
- Fedora Linux, R-devel, clang, gfortran

## R CMD check results

0 errors | 0 warnings | 1 note

* checking CRAN incoming feasibility ... NOTE
Maintainer: ‘Daniel Herszenhut <[email protected]>
New submission
Possibly mis-spelled words in DESCRIPTION:
GTFS (3:59, 31:33, 32:18, 33:33, 36:39)

This is gtfsio first submission. GTFS is an acronym for General Transit Feed Specification. The full specification name is provided both in the package title and description.
2 changes: 1 addition & 1 deletion inst/tinytest/test_import_gtfs.R
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ expect_error(
)

expect_error(
import_gtfs(path, extra_spec = list(levels = (elevation = "factor"))),
import_gtfs(path, extra_spec = list(levels = c(elevation = "factor"))),
pattern = paste0(
"Only character, integer and numeric ",
"are supported in 'extra_spec'\\."
Expand Down
9 changes: 7 additions & 2 deletions man/gtfsio.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a4fcd51

Please sign in to comment.