checkhelper

checkhelper copied to clipboard

Validation criteria

• [x] No Missing Rd-tags for pipe.Rd: \value

#73 PR has been merged into main

• [x] check_as_cran should not write in the user's home filespace

#74

• [x] \dontrun{} are replaced by \donttest{}

• [x] There is no remaining "data/iris.rda" at the root of the dev package (added during unit tests)

Context

• [x] If there are references describing the methods in your package, please add these in the description field of your DESCRIPTION file in the form authors (year) doi:... authors (year) arXiv:... authors (year, ISBN:...) or if those are not available: https:... with no space after 'doi:', 'arXiv:', 'https:' and angle brackets for auto-linking. (If you want to add a title as well please put it in quotes: "Title")

• [x] Please add \value to .Rd files regarding exported methods and explain the functions results in the documentation. Please write about the structure of the output (class) and also what the output means. (If a function does not return a value, please document that too, e.g. \value{No return value, called for side effects} or similar) Missing Rd-tags: pipe.Rd: \value

• [x] \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.

Please unwrap the examples if they are executable in < 5 sec, or replace dontrun{} with \donttest{}.

• [x] Please ensure that your functions do not write by default or in your examples/vignettes/tests in the user's home filespace (including the package directory and getwd()). This is not allowed by CRAN policies. Please omit any default path in writing functions. In your examples/vignettes/tests you can write to tempdir(). -> R/check_as_cran.R

CRAN_comments.md

## R CMD check results

* Tested on GitHub Actions, {rhub} and Win-devel and Mac-release
* Fixed the previous error on submission concerning the number of CPU used.

0 errors | 0 warnings | 1 note

* There is one note because this is a new package.

## Address CRAN comments

- If there are references describing the methods in your package, please
add these in the description field of your DESCRIPTION file in the form
authors (year) doi:...
authors (year) arXiv:...
authors (year, ISBN:...)
or if those are not available: https:...
with no space after 'doi:', 'arXiv:', 'https:' and angle brackets for
auto-linking. (If you want to add a title as well please put it in
quotes: "Title")
=> We added link to CRAN GitHub mirror as `@references` where URL was presented.

- Please add \value to .Rd files regarding exported methods and explain
the functions results in the documentation. Please write about the
structure of the output (class) and also what the output means. (If a
function does not return a value, please document that too, e.g.
\value{No return value, called for side effects} or similar)
Missing Rd-tags:
pipe.Rd: \value
=> @return tag was added to the R script

- \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.
Please unwrap the examples if they are executable in < 5 sec, or replace
\dontrun{} with \donttest{}.
=> We keep the use of \dontrun in majority in our examples. There are required in our function documentation because we cannot let open the possibility that checks may be run on the \donttest as we know they will fail. Indeed, we run checks inside checks which make it difficult to account for the side-effects on CRAN machines. The real use by package users will be on a direct use. 


- Please ensure that your functions do not write by default or in your
examples/vignettes/tests in the user's home filespace (including the
package directory and getwd()). This is not allowed by CRAN policies.
Please omit any default path in writing functions. In your
examples/vignettes/tests you can write to tempdir(). -> R/check_as_cran.R
=> In `check_as_cran`, we set `check_dir = tempfile()` and `scratch = tempfile()` by default so that it does not write in the User's home filespace.