Pre-submission gates

audit_check() - check with CRAN settings

R CMD check on your machine and R CMD check on CRAN’s machines do not see the same environment: CRAN sets a long list of env vars and options before running the incoming-pretest. audit_check() mirrors those settings (sourced from https://github.com/r-devel/r-dev-web/tree/master/CRAN/) so a check that is green locally has the highest chance of being green on CRAN.

It is heavier than a plain rcmdcheck::rcmdcheck() - use it as the final gate, not as the audit driver during development.

# Store the check outputs in a directory you can browse afterwards.
check_output <- tempfile("example")

# `Ncpus = 1` matches CRAN's incoming-pretest. Bump it on a multi-core
# host (e.g. `Ncpus = parallel::detectCores() - 1`) when you just need
# a fast pre-flight rather than a faithful CRAN reproduction.
audit_check(pkg = ".", check_output = check_output, Ncpus = 1)

# Open the directory with all outputs (logs, install, tests).
utils::browseURL(check_output)

The settings are originally tuned for the Linux pretest, so audit_check() will run on any OS but the env it reproduces is the Linux one.

check_n_covr() - check plus coverage in one pass

Both R CMD check and covr::package_coverage() run the unit test suite. On a package with a slow suite, running them in sequence doubles the wait.

check_n_covr() splits the work: it runs R CMD check with --no-tests (every step except the test runner), then runs the test suite once under covr’s line-trace instrumentation. The return value carries both halves.

res <- check_n_covr(".")
res$check                                # CRAN errors / warnings / notes
covr::percent_coverage(res$coverage)     # global percentage

Use this during the late dev cycle - by the time you want a coverage number you usually want a clean CRAN check too, and you no longer want to pay the test cost twice.

audit_userspace() - no files left after check

CRAN flags packages whose tests, examples or vignettes leak files into the user space:

Check: for non-standard things in the check directory
Result: NOTE
    Found the following files/directories:
     'extrapackage'

audit_userspace() runs the package’s tests, examples, vignettes and full check, takes file-system snapshots of the package directory and tempdir() between each step, and lists every file that appeared in those two locations outside the check directory. (Files created elsewhere - ~/.cache, ~/.config, etc. - are out of scope; CRAN’s “non-standard things in the check directory” NOTE only catches package-local leaks, which is exactly what this audit targets.)

leaks <- audit_userspace(pkg = ".")
leaks

Each row points to the source (tests, examples, vignettes, check), the file, and where it landed. Use that to decide whether the offending code should withr::local_*() its temp files, unlink() on exit, or move under tempdir().

This audit takes file-system snapshots that depend on the package’s real run, which is why it can’t share the rcmdcheck object with audit_globals().