Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
Package: mobdb
Type: Package
Title: Access the Mobility Database API to Discover Transit Feeds
Version: 1.0.0
Title: Access the 'Mobility Database' API to Discover Transit Feeds
Version: 1.0.1
Authors@R:
person("Jason", "Adle", , "developer@jasonadle.dev", role = c("aut", "cre", "cph"))
Description: Search and access transit feed data from the
Mobility Database <https://mobilitydatabase.org>. The package wraps the 'Mobility Database'
API, allowing users to discover GTFS (General Transit Feed Specification) and
GBFS (General Bikeshare Feed Specification) feeds from agencies worldwide.
Functions are designed to integrate seamlessly with
'Mobility Database' <https://mobilitydatabase.org>. The package wraps the 'Mobility Database'
API, allowing users to discover 'GTFS' (General Transit Feed Specification) and
'GBFS' (General Bikeshare Feed Specification) feeds from agencies worldwide.
Functions are designed to integrate seamlessly with
packages like 'tidytransit' and 'gtfstools' for subsequent feed analysis.
URL: https://mobdb.jasonadle.dev, https://github.com/jasonad123/mobdb
BugReports: https://github.com/jasonad123/mobdb/issues
License: MIT + file LICENSE
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
Depends:
Depends:
R (>= 4.1.0)
Imports:
curl,
Expand Down
12 changes: 10 additions & 2 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# mobdb 1.0.1

## Bug fixes

* Quoted certain software/API items in in the package description per CRAN
* Added documentation to `mobdb_cache_clear()`
* Replaced remaining `if(FALSE)`-disabled examples with `\dontrun{}` or runnable equivalents

# mobdb 1.0.0

Setting the stage for an initial CRAN release and bugfixes.
Expand Down Expand Up @@ -71,7 +79,7 @@ None.

## Minor changes

* **New!** Vignette: "Working with GTFS-Realtime and GBFS"
* **New!** Vignette: "Working with GTFS-Realtime and GBFS"
* `feeds_bbox()` supports both numeric vectors and sf bbox objects
* Added `sf` to Suggests for bbox object support

Expand Down Expand Up @@ -142,4 +150,4 @@ Initial release. Provides R access to the Mobility Database Catalog API for disc
* Search and filter feeds with `mobdb_feeds()`
* Access historical datasets with `mobdb_datasets()`
* Direct integration with tidytransit via `mobdb_read_gtfs()`
* Secure authentication with `mobdb_set_key()`
* Secure authentication with `mobdb_set_key()`
6 changes: 4 additions & 2 deletions R/cache.R
Original file line number Diff line number Diff line change
Expand Up @@ -150,9 +150,11 @@ get_cache_ttl <- function(endpoint_type = c("feeds", "search", "datasets", "hist
#' # Set for current session only
#' mobdb_cache_path("~/my_mobdb_cache")
#' }
#' @examplesIf FALSE
#'
#' \dontrun{
#' # Set permanently in .Renviron
#' mobdb_cache_path("~/my_mobdb_cache", install = TRUE)
#' }
mobdb_cache_path <- function(path = NULL, install = FALSE, overwrite = FALSE) {

# If no path provided, just show current path
Expand Down Expand Up @@ -325,7 +327,7 @@ mobdb_cache_list <- function() {
#' @param older_than Optional. Remove only files older than this many days.
#' If NULL (default), removes all cached files.
#'
#' @return NULL
#' @return Invisibly returns NULL. Called for its side effect of removing cached files (and, if requested via older_than, only those older than the given number of days)
#' @export
#'
#' @examples
Expand Down
11 changes: 5 additions & 6 deletions R/integration-tidytransit.R
Original file line number Diff line number Diff line change
Expand Up @@ -167,17 +167,16 @@ mobdb_read_gtfs <- function(feed_id, dataset_id = NULL, ...) {
#' # Download a specific historical version (feed_id auto-extracted from dataset_id)
#' historical <- download_feed(dataset_id = "mdb-53-202507240047")
#'
#' @examplesIf FALSE
#' # Filter by location (may return multiple feeds requiring disambiguation)
#' gtfs <- download_feed(
#' # Filter by location (may return multiple feeds requiring disambiguation,
#' # in which case refine with `provider` or `feed_name`)
#' try(download_feed(
#' country_code = "US",
#' subdivision_name = "California",
#' municipality = "San Francisco"
#' )
#' ))
#'
#' # Save GTFS feed to disk (raw file, no parsing required)
#' path <- download_feed("mdb-247", export_path = "data/gtfs/trimet.zip")
#'
#' path <- download_feed("mdb-247", export_path = tempfile(fileext = ".zip"))
#'
#' @seealso
#' [mobdb_datasets()] to list all available historical versions,
Expand Down
4 changes: 3 additions & 1 deletion R/utils-auth.R
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,11 @@
#' # Set token for current session
#' mobdb_set_key("your_refresh_token_here")
#' }
#' @examplesIf FALSE
#'
#' \dontrun{
#' # Set token permanently in .Renviron
#' mobdb_set_key("your_refresh_token_here", install = TRUE)
#' }
#' @concept authentication
#' @export
mobdb_set_key <- function(refresh_token, install = FALSE) {
Expand Down
13 changes: 12 additions & 1 deletion cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,17 @@

* This is a new release.

## Resubmission

This is a resubmission addressing CRAN feedback from the initial submission:

* Quoted `'Mobility Database'`, `'GTFS'` and `'GBFS'` in the `Description` field.
* Added a `\value` tag to `mobdb_cache_clear()`.
* Removed the remaining `if(FALSE)`-style disabled examples
(`mobdb_cache_path()`, `mobdb_set_key()`, `download_feed()`), replacing them
with `\dontrun{}` where the example writes permanently to `.Renviron`, or
folding them into an existing runnable `@examplesIf` block otherwise.

## Test environments

* Local: macOS 15.7.7, R 4.6.1
Expand All @@ -28,4 +39,4 @@
`gtfs_to_spec_format()`), since `@examplesIf mobdb_can_run_examples()`
allows those examples to execute live API calls in that environment. On
CRAN's build servers, no API key is configured, so these examples are
skipped entirely and this NOTE will not occur.
skipped entirely and this NOTE will not occur.
13 changes: 6 additions & 7 deletions man/download_feed.Rd

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

4 changes: 2 additions & 2 deletions man/mobdb-package.Rd

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

3 changes: 3 additions & 0 deletions man/mobdb_cache_clear.Rd

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

5 changes: 3 additions & 2 deletions man/mobdb_cache_path.Rd

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

5 changes: 3 additions & 2 deletions man/mobdb_set_key.Rd

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