pkgcheck: Generate report on package compliance with rOpenSci...

In pkgcheck: Package Checks for 'rOpenSci'

Generate report on package compliance with rOpenSci Statistical Software requirements

Description

Generate report on package compliance with rOpenSci Statistical Software requirements

Usage

pkgcheck(
  path = ".",
  goodpractice = TRUE,
  use_cache = TRUE,
  extra_env = .GlobalEnv
)

Arguments

path	Path to local repository
goodpractice	If FALSE, skip most goodpractice checks except lintr and 'DESCRIPTION' checks. May be useful in development stages to more quickly check other aspects.
use_cache	Checks are cached for rapid retrieval, and only re-run if the git hash of the local repository changes. Setting use_cache to FALSE will force checks to be re-run even if the git hash has not changed.
extra_env	Additional environments from which to collate checks. Other package names may be appended using c, as in c(.GlobalEnv, "mypkg").

Value

A pkgcheck object detailing all package assessments automatically applied to packages submitted for peer review.

See Also

Other pkgcheck_fns: pkgcheck_bg(), print.pkgcheck()

Examples

f <- system.file ("extdata", "pkgstats_9.9.tar.gz", package = "pkgstats")
path <- pkgstats::extract_tarball (f)

## Not run: 
checks <- pkgcheck (path)
summary (checks)

## End(Not run)
fs::dir_delete (path)

pkgcheck documentation built on Oct. 13, 2026, 5:06 p.m.