Skip to content

Commit

Permalink
CRAN submit for patch issue #3
Browse files Browse the repository at this point in the history
  • Loading branch information
joshualerickson committed Apr 1, 2023
1 parent f894f3e commit 29684b5
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 16 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: whitewater
Title: Parallel Processing Options for Package 'dataRetrieval'
Version: 0.1.2
Version: 0.1.3
Authors@R:
person(given = "Josh",
family = "Erickson",
Expand Down
4 changes: 4 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# whitewater 0.1.3

* patch with functions that use `dplyr::slice()`.

# whitewater 0.1.1.9000

* Added a `NEWS.md` file to track changes to the package.
Expand Down
15 changes: 0 additions & 15 deletions cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,3 @@ There were no ERRORs , NOTEs or WARNINGs.
## Downstream dependencies

There are currently no downstream dependencies for this package.

## Notes

**1. (problem)** " \\dontrun{} should only be used if the example really cannot be executed
(e.g. because of missing additional software, missing API keys, ...) by
the user. That's why wrapping examples in \\dontrun{} adds the comment
("# Not run:") as a warning for the user. Does not seem necessary.
Please replace \\dontrun with \\donttest.
All your examples are wrapped in \\dontrun{} and therefore do not get tested.
Please unwrap the examples if that is feasible and if they can be
executed in < 5 sec for each Rd file or create additionally small toy
examples to allow automatic testing.
Please put functions which download data in \\donttest{}."

**1. (response)** The package relies on an API, which requires a connection to the internet. In addition, the `@examples` use parallel processing in some cases. For this reason I think `\dontrun{}` is the best option for `@examples` with API calls and parallel processing examples.

0 comments on commit 29684b5

Please sign in to comment.