options_params: Checked Options

In checked: Systematically Run R CMD Checks

Checked Options

Description

Checked Options

Arguments

results_error_on	character vector indicating whether R error should be thrown when issues are discovered when generating results. "never" means that no errors are thrown. If "issues" then errors are emitted only on issues, whereas "potential issues" stands for error on both issues and potential issues. (Defaults to "never", overwritable using option 'checked.results_error_on' or environment variable 'R_CHECKED_RESULTS_ERROR_ON')
check_args	character vector of args passed to the R CMD check. (Defaults to c("--timings", "--ignore-vignettes", "--no-manual"), overwritable using option 'checked.check_args' or environment variable 'R_CHECKED_CHECK_ARGS')
results_keep	character vector indicating which packages should be included in the results. "all" means that all packages are kept. If "issues" then only packages with issues identified, whereas "potential_issues" stands for keeping packages with both "issues" and "potential_issues". (Defaults to "all", overwritable using option 'checked.results_keep' or environment variable 'R_CHECKED_RESULTS_KEEP')
check_envvars	named character vector of environment variables to use during R CMD check. (Defaults to ⁠c(⁠R_CHECK_FORCE_SUGGESTS⁠= FALSE,⁠R_CHECK_RD_XREFS⁠= FALSE, ; ⁠R_CHECK_SYSTEM_CLOCK⁠= FALSE,⁠R_CHECK_SUGGESTS_ONLY⁠ = TRUE)⁠, overwritable using option 'checked.check_envvars' or environment variable 'R_CHECKED_CHECK_ENVVARS')
tty_tick_interval	tty refresh interval when reporting results in milliseconds (Defaults to 0.1, overwritable using option 'checked.tty_tick_interval' or environment variable 'R_CHECKED_TTY_TICK_INTERVAL')
check_build_args	character vector of args passed to the R CMD build. (Defaults to c("--no-build-vignettes", "--no-manual"), overwritable using option 'checked.check_build_args' or environment variable 'R_CHECKED_CHECK_BUILD_ARGS')
restore	logical indicating whether output directory should be unlinked before running checks. If FALSE, an attempt will me made to restore previous progress from the same output (Defaults to NA, overwritable using option 'checked.restore' or environment variable 'R_CHECKED_RESTORE')

See Also

Other documentation: options()

checked documentation built on June 10, 2025, 9:08 a.m.