Check a package using rcmdcheck::rcmdcheck()
,
which ultimately calls R CMD check
.
The preparation consists of installing package dependencies
via remotes::install_deps()
with dependencies = TRUE
,
and updating all packages.
step_rcmdcheck(..., warnings_are_errors = NULL,
notes_are_errors = NULL, args = c("--no-manual", "--as-cran"),
build_args = "--force", error_on = "warning",
repos = getOption("repos"), timeout = Inf)
Ignored, used to enforce naming of arguments.
[flag]
Deprecated, use error_on
.
[character]
Passed to rcmdcheck::rcmdcheck()
, default:
c("--no-manual", "--as-cran")
.
[character]
Passed to rcmdcheck::rcmdcheck()
, default:
"--force"
.
[character]
Whether to throw an error on R CMD check failures. Note that the check is
always completed (unless a timeout happens), and the error is only thrown
after completion. If "never", then no errors are thrown. If "error", then
only ERROR failures generate errors. If "warning", then WARNING failures
generate errors as well. If "note", then any check failure generated an
error.
[character]
Passed to rcmdcheck::rcmdcheck()
, default:
getOption("repos")
.
[numeric]
Passed to rcmdcheck::rcmdcheck()
, default:
Inf
.
Packages shipped with the R-installation will not be updated as they will be
overwritten by the Travis R-installer in each build.
If you want these package to be updated, please add the following
step to your workflow: add_code_step(remotes::update_packages(<pkg>)
.
This step uses a dedicated library,
a subdirectory tic-pkg
of the current user library
(the first element of .libPaths()
),
for the checks.
This is done to minimize conflicts between dependent packages
and packages that are required for running the various steps.