pkgcheck
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
Argument |
Description |
---|---|
|
Path to local repository |
|
If |
|
Checks are cached for rapid retrieval, and only re-run if the git hash of the local repository changes. Setting |
|
Additional environments from which to collate checks. Other package names may be appended using |
Value
A pkgcheck
object detailing all package assessments automatically
applied to packages submitted for peer review.
Seealso
Other pkgcheck_fns:
pkgcheck_bg
,
print.pkgcheck
Examples
checks <- pkgcheck ("/path/to/my/package") # default full check
summary (checks)
# Or to run only checks implemented in 'pkgcheck' and not the
# additional \pkg{goodpractice} checks:
checks <- pkgcheck ("/path/to/my/package", goodpractice = FALSE)
summary (checks)