View source: R/macro-package-checks.R
do_package_checks | R Documentation |
do_package_checks()
adds default steps related to package checks
to the "before_install"
, "install"
, "script"
and "after_success"
stages:
This macro is only available for R packages.
step_install_deps()
in the "install"
stage, using the
repos
argument.
step_session_info()
in the "install"
stage.
step_rcmdcheck()
in the "script"
stage, using the
warnings_are_errors
, notes_are_errors
, args
, and
build_args
arguments.
A call to covr::codecov()
in the "after_success"
stage
(only if the codecov
flag is set)
do_package_checks(
...,
codecov = !ci_is_interactive(),
warnings_are_errors = NULL,
notes_are_errors = NULL,
args = NULL,
build_args = NULL,
error_on = "warning",
repos = repo_default(),
dependencies = TRUE,
timeout = Inf,
check_dir = "check"
)
... |
Ignored, used to enforce naming of arguments. |
codecov |
|
warnings_are_errors , notes_are_errors |
|
args |
Default for local runs: Default for Windows:
On GitHub Actions option "–no-manual" is always used (appended to custom
user input) because LaTeX is not available and installation is time
consuming and error prone. |
build_args |
|
error_on |
|
repos |
|
dependencies |
What kinds of dependencies to install. Most commonly one of the following values:
|
timeout |
|
check_dir |
|
Other macros:
do_blogdown()
,
do_bookdown()
,
do_drat()
,
do_pkgdown()
,
do_readme_rmd()
,
list_macros()
dsl_init()
do_package_checks()
dsl_get()
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.