gp: Run good practice checks

In goodpractice: Advice on R Package Building

Run good practice checks

Description

To see the results, just print it to the screen.

Usage

gp(
  path = ".",
  checks = all_checks(),
  extra_preps = NULL,
  extra_checks = NULL,
  quiet = TRUE
)

Arguments

path	Path to a package root.
checks	Character vector, the checks to run. Defaults to all checks. Use all_checks to list all checks.
extra_preps	Custom preparation functions. See make_prep on creating preparation functions.
extra_checks	Custom checks. See make_check on creating checks.
quiet	Whether to suppress output from the preparation functions. Note that not all preparation functions produce output, even if this option is set to FALSE.

Value

A goodpractice object that you can query with a simple API. See results to start.

Examples

path <- system.file("bad1", package = "goodpractice")
# run a subset of all checks available
g <- gp(path, checks = all_checks()[3:16])
g

goodpractice documentation built on June 22, 2024, 9:55 a.m.