Learn R Programming

devtools (version 1.13.3)

check_cran: Check a package from CRAN.

Description

Internal function used to power revdep_check().

Usage

check_cran(pkgs, libpath = file.path(tempdir(), "R-lib"), srcpath = libpath,
  check_libpath = libpath, bioconductor = FALSE,
  type = getOption("pkgType"), threads = getOption("Ncpus", 1),
  check_dir = tempfile("check_cran"),
  install_dir = tempfile("check_cran_install"), env_vars = NULL,
  quiet_check = TRUE)

Arguments

pkgs

Vector of package names - note that unlike other devtools functions this is the name of a CRAN package, not a path.

libpath

Path to library to store dependencies packages - if you you're doing this a lot it's a good idea to pick a directory and stick with it so you don't have to download all the packages every time.

srcpath

Path to directory to store source versions of dependent packages - again, this saves a lot of time because you don't need to redownload the packages every time you run the package.

check_libpath

Path to library used for checking, should contain the top-level library from libpath.

bioconductor

Include bioconductor packages in checking?

type

binary Package type to test (source, mac.binary etc). Defaults to the same type as install.packages().

threads

Number of concurrent threads to use for checking. It defaults to the option "Ncpus" or 1 if unset.

check_dir, install_dir

Directory to store check and installation results.

env_vars

Environment variables set during R CMD check

quiet_check

If TRUE, suppresses individual R CMD check output and only prints summaries. Set to FALSE for debugging.

Value

Returns (invisibly) the directory where check results are stored.

Details

This function does not clean up after itself, but does work in a session-specific temporary directory, so all files will be removed when your current R session ends.