From 0115558fbd8fd09d26d151c1696b25304690487a Mon Sep 17 00:00:00 2001 From: James J Balamuta Date: Fri, 4 Jan 2019 13:21:20 -0600 Subject: [PATCH] Fixes for CRAN Check (#3) * 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. --- .travis.yml | 4 ++++ DESCRIPTION | 9 +++++---- NAMESPACE | 1 + NEWS.md | 10 ++++++++-- R/handlers.R | 1 + cran-comments.md | 38 ++++---------------------------------- man/errorist-package.Rd | 4 ++-- 7 files changed, 25 insertions(+), 42 deletions(-) diff --git a/.travis.yml b/.travis.yml index 83dbc8b..cfebf12 100644 --- a/.travis.yml +++ b/.travis.yml @@ -5,3 +5,7 @@ sudo: false cache: packages after_success: - Rscript -e 'covr::codecov()' + +env: + global: + - MAKEFLAGS="-j 2" diff --git a/DESCRIPTION b/DESCRIPTION index de45ec1..43c3c64 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,8 +1,9 @@ Package: errorist Title: Automatically Search Errors or Warnings -Version: 0.0.1.1000 -Authors@R: c(person("James", "Balamuta", - email = "balamut2@illinois.edu", role = c("aut", "cre"))) +Version: 0.0.2 +Authors@R: c(person("James", "Balamuta", email = "balamut2@illinois.edu", 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 @@ -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 diff --git a/NAMESPACE b/NAMESPACE index 5ca4c8d..7a3c8f5 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -6,3 +6,4 @@ export(disable_warning_shim) export(enable_error_shim) export(enable_errorist) export(enable_warning_shim) +importFrom(searcher,search_google) diff --git a/NEWS.md b/NEWS.md index 640cced..1a5e577 100644 --- a/NEWS.md +++ b/NEWS.md @@ -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 diff --git a/R/handlers.R b/R/handlers.R index cb7a63c..ed0f136 100644 --- a/R/handlers.R +++ b/R/handlers.R @@ -172,6 +172,7 @@ disable_warning_shim = function() { removed_handler = removeTaskCallback("ErroristWarningHandler") } +#' @importFrom searcher search_google #' @rdname shims #' @export #' @examples diff --git a/cran-comments.md b/cran-comments.md index 623a407..93beba0 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -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: - - +- This release is meant to resolve an import issue on the CRAN checks page. ## Reverse dependencies diff --git a/man/errorist-package.Rd b/man/errorist-package.Rd index b7219c4..63cb050 100644 --- a/man/errorist-package.Rd +++ b/man/errorist-package.Rd @@ -7,7 +7,7 @@ \title{errorist: Automatically Search Errors or Warnings} \description{ Provides environment hooks that obtain errors and warnings which -occur during the execution of code to automatically search for solutions. + occur during the execution of code to automatically search for solutions. } \details{ By default, \code{errorist} searches Google for both warnings and errors. @@ -21,6 +21,6 @@ Useful links: } \author{ -\strong{Maintainer}: James Balamuta \email{balamut2@illinois.edu} +\strong{Maintainer}: James Balamuta \email{balamut2@illinois.edu} (0000-0003-2826-8458) [copyright holder] }