Skip to contents

Check package

Usage

check(
  path = getwd(),
  style = TRUE,
  lints = TRUE,
  urls = TRUE,
  cran = FALSE,
  biocCheck = TRUE,
  coverage = FALSE
)

Arguments

path

character(1). File path (e.g. to package).

style

logical(1). Perform styler::style_pkg() checks.

lints

logical(1). Perform lintr::lint_package() checks.

urls

logical(1). Perform urlchecker::url_check() checks.

cran

logical(1). Perform additional CRAN submission checks.

biocCheck

logical(1). Perform additional Bioconductor checks. BiocCheck is only called when we detect "biocViews" metadata in DESCRIPTION file, and when the directory name is identical to the package name. BiocCheck currently errors on directory names that differ from package name.

coverage

logical(1). Check that unit tests provide sufficient coverage.

Value

TRUE on success, otherwise error.

Note

Updated 2022-04-29.

Examples

## > check()