Check the package structure without running any code
Arguments
- pkg
the path of the package to check
- ...
Named arguments passed on to
devtools::check
document
By default (
NULL
) will document if your installed roxygen2 version matches the version declared in theDESCRIPTION
file. UseTRUE
orFALSE
to override the default.build_args
Additional arguments passed to
R CMD build
...
Additional arguments passed on to
pkgbuild::build()
.manual
If
FALSE
, don't build and check manual (--no-manual
).cran
if
TRUE
(the default), check using the same settings as CRAN uses. Because this is a moving target and is not uniform across all of CRAN's machine, this is on a "best effort" basis. It is more complicated than simply setting--as-cran
.remote
Sets
_R_CHECK_CRAN_INCOMING_REMOTE_
env var. IfTRUE
, performs a number of CRAN incoming checks that require remote access.incoming
Sets
_R_CHECK_CRAN_INCOMING_
env var. IfTRUE
, performs a number of CRAN incoming checks.force_suggests
Sets
_R_CHECK_FORCE_SUGGESTS_
. IfFALSE
(the default), check will proceed even if all suggested packages aren't found.run_dont_test
Sets
--run-donttest
so that examples surrounded in\donttest{}
are also run. Whencran = TRUE
, this only affects R 3.6 and earlier; in R 4.0, code in\donttest{}
is always run as part of CRAN submission.env_vars
Environment variables set during
R CMD check
check_dir
Path to a directory where the check is performed. If this is not
NULL
, then the a temporary directory is used, that is cleaned up when the returned object is garbage collected.cleanup
vignettes
If
FALSE
, do not build or check vignettes, equivalent to usingargs = '--ignore-vignettes' and
build_args = '–no-build-vignettes'.error_on
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 onlyERROR
failures generate errors. If"warning"
, thenWARNING
failures generate errors as well. If"note"
, then any check failure generated an error. Its default can be modified with theRCMDCHECK_ERROR_ON
environment variable. If that is not set, then"never"
is used.path
Path to built package.
- args
additional r cmd check args
- quiet
do it without producing messages