Check the package structure without running any code
Arguments
- pkg
the path of the package to check
- ...
Named arguments passed on to
devtools::checkdocumentBy default (
NULL) will document if your installed roxygen2 version matches the version declared in theDESCRIPTIONfile. UseTRUEorFALSEto override the default.build_argsAdditional arguments passed to
R CMD build...Additional arguments passed on to
pkgbuild::build().manualIf
FALSE, don't build and check manual (--no-manual).cranif
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.remoteSets
_R_CHECK_CRAN_INCOMING_REMOTE_env var. IfTRUE, performs a number of CRAN incoming checks that require remote access.incomingSets
_R_CHECK_CRAN_INCOMING_env var. IfTRUE, performs a number of CRAN incoming checks.force_suggestsSets
_R_CHECK_FORCE_SUGGESTS_. IfFALSE(the default), check will proceed even if all suggested packages aren't found.run_dont_testSets
--run-donttestso 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_varsEnvironment variables set during
R CMD checkcheck_dirPath 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.cleanupvignettesIf
FALSE, do not build or check vignettes, equivalent to usingargs = '--ignore-vignettes'andbuild_args = '--no-build-vignettes'.error_onWhether to throw an error on
R CMD checkfailures. Note that the check is always completed (unless a timeout happens), and the error is only thrown after completion.error_onis passed through torcmdcheck::rcmdcheck(), which is the definitive source for what the different values mean. If not specified by the user, bothcheck()andcheck_built()default toerror_on = "never"in interactive use and"warning"in a non-interactive setting.pathPath to built package.
- args
additional r cmd check args
- quiet
do it without producing messages