Skip to content

Commit

Permalink
Fixes for CRAN Check (#3)
Browse files Browse the repository at this point in the history
* Use 2 cores on Travis-CI

* Add ORCID

* Import the search_google function to quiet CRAN checks

* Redocument.

* Update DESCRIPTION and NEWS file for new release.

* Update CRAN submission remarks.
  • Loading branch information
coatless authored Jan 4, 2019
1 parent 20ed3aa commit 0115558
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 42 deletions.
4 changes: 4 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,7 @@ sudo: false
cache: packages
after_success:
- Rscript -e 'covr::codecov()'

env:
global:
- MAKEFLAGS="-j 2"
9 changes: 5 additions & 4 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
Package: errorist
Title: Automatically Search Errors or Warnings
Version: 0.0.1.1000
Authors@R: c(person("James", "Balamuta",
email = "[email protected]", role = c("aut", "cre")))
Version: 0.0.2
Authors@R: c(person("James", "Balamuta", email = "[email protected]", role = c("aut", "cre", "cph"),
comment = c(ORCID = "0000-0003-2826-8458"))
)
Description: Provides environment hooks that obtain errors and warnings which
occur during the execution of code to automatically search for solutions.
URL: https://github.com/coatless/errorist
Expand All @@ -16,6 +17,6 @@ Suggests: testthat,
License: GPL (>= 2)
Encoding: UTF-8
LazyData: true
RoxygenNote: 6.0.1
RoxygenNote: 6.1.1
Roxygen: list(markdown = TRUE)
VignetteBuilder: knitr
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ export(disable_warning_shim)
export(enable_error_shim)
export(enable_errorist)
export(enable_warning_shim)
importFrom(searcher,search_google)
10 changes: 8 additions & 2 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# errorist 0.0.1.1000
# errorist 0.0.2

_in progress_
## Bugfixes

- Imported the `search_google` function from `searcher` to satisfy `R CMD check`.

## Test Infrastructure

- Enable the use of two cores to speed up Travis-CI builds.

# errorist 0.0.1

Expand Down
1 change: 1 addition & 0 deletions R/handlers.R
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,7 @@ disable_warning_shim = function() {
removed_handler = removeTaskCallback("ErroristWarningHandler")
}

#' @importFrom searcher search_google
#' @rdname shims
#' @export
#' @examples
Expand Down
38 changes: 4 additions & 34 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,14 @@
## Test environments

- local OS X install, R 3.4.3
- ubuntu 12.04 (on travis-ci), R 3.4.3
- local OS X install, R 3.5.2
- ubuntu 14.04 (on travis-ci), R 3.5.2
- win-builder (devel and release)

## R CMD check results

0 errors | 0 warnings | 1 note

Found the following (possibly) invalid URLs:
URL: http://www.r-pkg.org/pkg/errorist (moved to https://www.r-pkg.org:443/pkg/errorist)
From: inst/README.md
Status: 404
Message: Not Found
0 errors | 0 warnings | 0 note

- This is a new release.
- Because this is a new release, the above URL has yet to be activated as
the website only contains active packages on CRAN.

## Resubmit Remarks

From the initial submission, Uwe commented:

> Thanks, we see all your examples are in `\dontrun{}` and your tests are
> rather sparse.
> Can you somehow test the core functionality of your package, too?
I have since:

1. Unlocked all examples and added an example for `enable_error_shim()`/`disable_error_shim()`
2. Improved the unit tests:
- Verification that a `call` has been registered in `options(error = ...)`
- An output comparison of the function registered as the `options(error= ...)`
handler and the default search function.
- Checks surrounding the state of the `.errorist_env` when `errorist` is enabled.
3. Added a brief vignette to complement the extensive `README.md` file

Details of the code changes can be seen here:

<https://github.com/coatless/errorist/compare/165357dcf4c76bc4bd35b0049a47799f0c724fdb...master>
- This release is meant to resolve an import issue on the CRAN checks page.

## Reverse dependencies

Expand Down
4 changes: 2 additions & 2 deletions man/errorist-package.Rd

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

0 comments on commit 0115558

Please sign in to comment.