Skip to Content
Home » Package reference » devtools » check {devtools}

check {devtools}

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

Description

check automatically builds a package before using R CMD check 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.

Usage

check(pkg = ".", document = TRUE,
    doc_clean = getOption("devtools.cleandoc"),
    cleanup = TRUE, cran = TRUE, check_version = FALSE,
    force_suggests = TRUE, args = NULL, 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.
cleanup
if TRUE the check directory is removed if the check is successful - this allows you to inspect the results to figure out what went wrong. If FALSE the check directory is never removed.
cran
if TRUE (the default), check using the same settings as CRAN uses.
doc_clean
If TRUE, will delete all files in the man directory and regenerate them from scratch with roxygen. The default is to use the value of the "devtools.cleandoc" option.
check_version
if TRUE, check that the new version is greater than the current version on CRAN, by setting the _R_CHECK_CRAN_INCOMING_ environment variable to TRUE.
force_suggests
if FALSE, don't force suggested packages, by setting the _R_CHECK_FORCE_SUGGESTS_ environment variable to FALSE.
args
An optional character vector of additional command line arguments to be passed to R CMD   check.
quiet
if TRUE suppresses output from this function.

Details

During compilation, debug flags are set with compiler_flags(FALSE).

Devtools specific checks will be run after the R   CMD check.

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