The hardware and bandwidth for this mirror is donated by METANET, the Webhosting and Full Service-Cloud Provider.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]metanet.ch.

checkhelper

A toolkit for R package authors that turns each R CMD check warning or NOTE into a clear two-step workflow: audit what the issue is, then fix it. The goal is to reduce the risk of CRAN rejection.

Complete documentation in the {pkgdown} site: https://thinkr-open.github.io/checkhelper/

API at a glance

Each category of CRAN issue gets one read-only audit_*() function and, when an automated fix is safe, one fix_*() function. Type audit_<TAB> or fix_<TAB> in RStudio to discover the surface.

Lower-level helpers (asciify_file(), asciify_r_source(), find_nonascii_tokens(), create_example_pkg()) are also exported for fine-grained scripting.

The 10 historic functions (get_no_visible(), find_missing_tags(), asciify_pkg(), check_as_cran(), …) remain callable but emit a lifecycle::deprecate_warn() and delegate to the new façades - see NEWS.md for the full mapping.

Faster local check: check_n_covr()

check_n_covr(pkg) runs R CMD check (via devtools::check(args = "--no-tests")) and code coverage (via covr::package_coverage(type = "tests")) without running the unit-test suite twice. On a package with a slow test suite this roughly halves the wait. Returns a named list list(check = ..., coverage = ...).

res <- check_n_covr(".")
res$check
covr::percent_coverage(res$coverage)

Installation

From CRAN:

install.packages("checkhelper")

Latest from r-universe:

install.packages("checkhelper", repos = "https://thinkr-open.r-universe.dev")

From GitHub:

remotes::install_github("thinkr-open/checkhelper")

Quick start

The recommended dev-time workflow runs R CMD check once and reuses the result across every audit that accepts a checks = argument. create_example_pkg() ships a fake package that trips every audit when you opt into the full set of fixtures - use it to feel the flow end to end:

library(checkhelper)

# `with_nonascii = TRUE` adds a file with French accents in comments
# and strings; `with_undocumented_data = TRUE` saves an undocumented
# dataset under data/. Both default to FALSE for backwards compat.
pkg <- create_example_pkg(with_nonascii = TRUE,
                          with_undocumented_data = TRUE)

# Run R CMD check ONCE.
chk <- rcmdcheck::rcmdcheck(pkg, args = "--as-cran")

# Static audits - no check needed.
audit_tags(pkg)
audit_ascii(pkg)
audit_dataset_doc(pkg)
audit_citation(pkg)
audit_dontrun(pkg)
audit_description(pkg)
audit_downloads(pkg)

# Audits that consume the check - reuse `chk` via the `checks =` argument.
audit_globals(pkg, checks = chk)

# Apply the safe fixes.
fix_globals(pkg, checks = chk, write = TRUE)
fix_ascii(pkg, dry_run = FALSE)
fix_dataset_doc("demo_dataset", pkg = pkg,
                description = "A small demo dataset",
                source = "Generated by create_example_pkg()")

See vignette("auditing-an-r-package", package = "checkhelper") for the full walkthrough (per-issue cheatsheet, when to share chk, how to fix each category). For the heavier final-gate audits - audit_check() (full CRAN environment) and audit_userspace() (no files left after check) - see vignette("pre-submission-gates", package = "checkhelper").

Code of Conduct

Please note that the checkhelper project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.