rcmd_build_tools: Call R CMD 'command' with build tools active
In r-lib/pkgbuild: Find Tools Needed to Build R Packages

rcmd_build_tools

R Documentation

Call R CMD 'command' with build tools active

Description

This is a wrapper around callr::rcmd_safe() that checks that you have build tools available, and on Windows, automatically sets the path to include Rtools.

Usage

rcmd_build_tools(..., env = character(), required = TRUE, quiet = FALSE)

Arguments

`...`	Parameters passed on to `rcmd_safe`.
`env`	Additional environment variables to set. The defaults from `callr::rcmd_safe_env()` are always set.
`required`	If `TRUE`, and build tools are not available, will throw an error. Otherwise will attempt to run `code` without them.
`quiet`	if `TRUE` suppresses output from this function.

Examples

# These env vars are always set
callr::rcmd_safe_env()

if (has_build_tools()) {
  rcmd_build_tools("CONFIG", "CC")$stdout
  rcmd_build_tools("CC", "--version")$stdout
}

r-lib/pkgbuild documentation built on March 17, 2024, 10:24 p.m.