Learn R Programming

MazamaCoreUtils (version 0.4.3)

packageCheck: Run package checks

Description

When multiple devlopers are working on a package, it is crucially important that they check their code changes often. After merging changes from multiple developers it is equally important to check the package thoroughly.

The problem is that frequent checks should be quick or developers won't do them while thorough checks are, by nature, slow.

Our solution is to provide shorthand functions that wrap devtools::check() and pass it a variety of different arguments.

Usage

check(pkg = ".")

check_fast(pkg = ".")

check_faster(pkg = ".")

check_fastest(pkg = ".")

check_slow(pkg = ".")

check_slower(pkg = ".")

check_slowest(pkg = ".")

Arguments

pkg

Package location passed to devtools::check().

Value

No return.

Details

The table below describes the args passed:

check_slowest() | args = c("--run-donttest", "--run-dontrun", "--use-gct")
check_slower() | args = c("--run-donttest", "--run-dontrun")
check_slow() | args = c("--run-donttest")
check_() | args = c()
check_fast() | args = c("--ignore-vignettes")
| build_args = c("--no-build-vignettes")
check_fastest() | args = c("--ignore-vignettes", "--no-examples")
| build_args = c("--no-build-vignettes", "--no-examples")
check_fastest() | args = c("--ignore-vignettes", "--no-examples", "--no-manual", "--no-tests")
| build_args = c("--no-build-vignettes", "--no-manual")

See Also

check