check_for_cran {rhub} | R Documentation |
Check an R-package on R-hub, for a CRAN submission
Description
This function calls check()
with arguments and platforms, that
are suggested for a CRAN submission.
Usage
check_for_cran(
path = ".",
email = NULL,
check_args = "--as-cran",
env_vars = c(`_R_CHECK_FORCE_SUGGESTS_` = "true", `_R_CHECK_CRAN_INCOMING_USE_ASPELL_`
= "true"),
platforms = NULL,
...
)
Arguments
path |
Path to a directory containing an R package, or path to
source R package tarball built with |
email |
Email address to send notification to about the check.
It must be a validated email address, see |
check_args |
Arguments for |
env_vars |
Character vecctor of environment variables to set on the builder.
By default |
platforms |
A character vector of one or more platforms to build/check
the package on. See |
... |
Additional arguments are passed to |
Details
In particular, if platforms
is NULL
(the default), then
It checks the package on Windows, and Linux.
It checks the package on R-release and R-devel.
It uses the
--as-cran
argument toR CMD check
.It requires all dependencies, including suggested ones.
This function is wrapped by devtools::check_rhub()
which you
might find useful if you load devtools
via your .Rprofile (see usethis::use_devtools()
).
Value
An rhub_check object.
Examples
## Not run:
ch <- check_for_cran("package", show_status = FALSE)
ch$update()
ch$livelog(3)
## End(Not run)