checkPackage: Check R package

In gdrplatform/gDRstyle: A package with style requirements for the gDR suite

Check R package

Description

Used in gDR platform pacakges' CI/CD pipelines to check that the package abides by gDRstyle stylistic requirements, passes rcmdcheck, and ensures that the dependencies.yml file used to build gDR platform's docker image is kept up-to-date with the dependencies listed in the package's DESCRIPTION file.

Usage

checkPackage(
  pkgName,
  repoDir,
  subdir = NULL,
  fail_on = "warning",
  bioc_check = FALSE,
  run_examples = TRUE,
  skip_lint = FALSE,
  skip_tests = FALSE,
  build_vignettes = TRUE,
  check_vignettes = TRUE,
  as_cran = FALSE
)

Arguments

pkgName	String of package name.
repoDir	String of path to repository directory.
subdir	String of relative path to the R package root directory from the repoDir.
fail_on	String specifying the level at which check fail. Supported values: "note", "warning" (default) and "error".
bioc_check	Logical whether bioc check should be performed
run_examples	Logical whether examples check should be performed
skip_lint	skip lint checks
skip_tests	skip tests
build_vignettes	build vignettes
check_vignettes	check vignettes
as_cran	run with as_cran flag

Value

NULL invisibly.

Examples

checkPackage(
  pkgName = "fakePkg",
  repoDir = system.file(package = "gDRstyle", "tst_pkgs", "dummy_pkg"),
  fail_on = "error"
)

gdrplatform/gDRstyle documentation built on Nov. 9, 2024, 9:28 p.m.