Skip to Content

check {devtools}

Build and check a package, cleaning up automatically on success.
Package: 
devtools
Version: 
1.11.1

Description

check automatically builds and checks a source package, using all known best practices. check_built checks an already built package.

Usage

check(pkg = ".", document = TRUE, build_args = NULL, ...,
  manual = FALSE, cran = TRUE, check_version = FALSE,
  force_suggests = FALSE, run_dont_test = FALSE, args = NULL,
  env_vars = NULL, quiet = FALSE, check_dir = tempdir(), cleanup = TRUE)

check_built(path = NULL, cran = TRUE, check_version = FALSE,
  force_suggests = FALSE, run_dont_test = FALSE, manual = FALSE,
  args = NULL, env_vars = NULL, check_dir = tempdir(), quiet = FALSE)

Arguments

pkg
package description, can be path or package name. See as.package for more information
document
if TRUE (the default), will update and check documentation before running formal check.
build_args
Additional arguments passed to R CMD build
...
Additional arguments passed on to 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.
check_version
Sets _R_CHECK_CRAN_INCOMING_ env var. If TRUE, performns a number of checked related to version numbers of packages on CRAN.
force_suggests
Sets _R_CHECK_FORCE_SUGGESTS_. If FALSE (the default), check will proceed even if all suggested packages aren't found.
run_dont_test
Sets --run-donttest so that tests surrounded in \dontest{} are also tested. This is important for CRAN submission.
args
Additional arguments passed to R CMD check
env_vars
Environment variables set during R CMD check
quiet
if TRUE suppresses output from this function.
check_dir
the directory in which the package is checked
cleanup
Deprecated.
path
Path to built package.

Details

Passing R CMD check is essential if you want to submit your package to CRAN: you must not have any ERRORs or WARNINGs, and you want to ensure that there are as few NOTEs as possible. If you are not submitting to CRAN, at least ensure that there are no ERRORs or WARNINGs: these typically represent serious problems.

check automatically builds a package before calling check_built as this is the recommended way to check packages. Note that this process runs in an independent realisation of R, so nothing in your current workspace will affect the process.

Values

An object containing errors, warnings, and notes.

Environment variables

Devtools does its best to set up an environment that combines best practices with how check works on CRAN. This includes:

  • The standard environment variables set by devtools: r_env_vars. Of particular note for package tests is the NOT_CRAN env var which lets you know that your tests are not running on cran, and hence can take a reasonable amount of time.
  • Debugging flags for the compiler, set by compiler_flags(FALSE).
  • If aspell is found _R_CHECK_CRAN_INCOMING_USE_ASPELL_ is set to TRUE. If no spell checker is installed, a warning is issued.)
  • env vars set by arguments check_version and force_suggests

See Also

release if you want to send the checked package to CRAN.

Documentation reproduced from package devtools, version 1.11.1. License: GPL (>= 2)