local_check_linux: Run a package check locally, in a Docker container

In rhub: Connect to 'R-hub'

Run a package check locally, in a Docker container

Description

Run a package check locally, in a Docker container. UNTESTED ON WINDOWS, bug reports welcome. :-)

Usage

local_check_linux(
  path = ".",
  quiet = FALSE,
  image = NULL,
  valgrind = FALSE,
  check_args = character(),
  env_vars = character(),
  timeout = Inf,
  artifacts = tempfile()
)

Arguments

path	Path to a directory containing an R package, or path to source R package tarball built with R CMD build or devtools::build().
quiet	Whether to print the check output
image	Docker image to use. If NULL, a default image is selected.
valgrind	Whether to run the check with Valgrind.
check_args	Extra arguments for the R CMD check command.
env_vars	Environment variables to set on the builder machine before the check. A named character vector.
timeout	Timeout for a check, a difftime object or a scalar that will be interpreted as seconds.
artifacts	Where to copy the build artifacts after the build.

Details

You'll need to have bash and Docker installed.

Value

An rcmdcheck::rcmdcheck object, with extra fields:

• all_output: all output from the check, both standard output and error.

• container_name: name of the Docker container that performed the build. It is a random name.

• artifacts: directory of build artifacts.

rhub documentation built on Aug. 31, 2022, 5:06 p.m.