Run 'R CMD check' from 'R' and Capture Results

Run 'R CMD check' from 'R' programmatically, and capture the results of the individual checks.


Project Status: Active - The project has reached a stable, usable state and is being actively developed. Linux Build Status Windows Build status CRAN RStudio mirror downloads Coverage Status

Run R CMD check form R programatically, and capture the results of the individual checks.

Installation

source("https://install-github.me/r-lib/rcmdcheck")

Usage

library(rcmdcheck)
rcmdcheck("path/to/R/package")

Call rcmdcheck() on a source R package .tar.gz file, or on a folder containing your R package. Supply quiet = FALSE if you want to omit the output. The result of the check is returned, in a list with elements errors, warnings, and notes. Each element is a character vector, and one element of the character vectors is a single failure.

License

MIT © Mango Solutions, Gábor Csárdi, RStudio

News

1.3.0

  • New rcmdcheck_process class to run R CMD check in the background.

  • rcmdcheck() now supports timeouts (default is 10 minutes).

  • Checks now capture and print installation and test failures.

  • Checks now record and print the duration of the check.

  • Checks now record and print session information from the check session (#22).

  • rcmdcheck() new keep files until the returned check object is deleted, if check was run in a temporary directory (the default) (#23).

  • New xopen() to show the check file in a file browser window (#61).

  • Checks now save install.out and also DESCRIPTION in the result, and save the standard error and the exit status as well.

  • rcmdcheck() printing is now better: the message from the check that is actually being performed is shown on the screen.

  • rcmdcheck() now shows a spinner while running check.

  • rcmdcheck() results now have a summary() method for check comparisons.

  • rcmdcheck() results now have a new check_details() method, to query the check results programmatically. (No need to use $errors, $warnings, etc. directly.)

  • Checks now find package root automatically (#18).

  • rcmdcheck() now has an error_on argument to throw an error on an R CMD check failure (#51).

  • rcmdcheck() result printing is now better, the colors are consistent (#54).

1.2.1

  • Compare two check results with compare_checks or compare check results to CRAN with compare_to_cran.

  • The result object has more metadata: package name, version, R version and platform.

  • Refined printing of the result.

  • rcmdcheck() works on tarballs build via R CMD build now.

  • Parse R CMD check results: parse_check, parse_check_url.

  • Download and parse check results for CRAN packages.

  • Report errors during the build, typically vignette errors.

  • Use the callr package (https://github.com/r-lib/callr) for running R CMD commands.

1.1.0

  • New arguments libpath and repos to set the library path and the default CRAN repository

  • Do not run tests on CRAN.

1.0.0

First public release.

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("rcmdcheck")

1.3.2 by Gábor Csárdi, 6 days ago


https://github.com/r-Lib/rcmdcheck#readme


Report a bug at https://github.com/r-Lib/rcmdcheck/issues


Browse source code at https://github.com/cran/rcmdcheck


Authors: Gábor Csárdi


Documentation:   PDF Manual  


MIT + file LICENSE license


Imports callr, cli, crayon, desc, digest, pkgbuild, prettyunits, R6, rprojroot, sessioninfo, utils, withr, xopen

Suggests covr, knitr, mockery, rmarkdown, testthat


Imported by devtools, document, goodpractice, rhub.

Suggested by littler.


See at CRAN