Description Usage Arguments Details References Examples
isCRANcheck
tries to identify if one is
running CRAN-like checks.
isCRAN_timing
tells if one is running CRAN check
with flag '--timing'
.
Currently, isCHECK
checks both CRAN expected
flags, the value of environment variable
_R_CHECK_RUNNING_UTESTS_
, and the value of option
R_CHECK_RUNNING_EXAMPLES_
. It will return
TRUE
if any of these environment variables is set
to anything not equivalent to FALSE
, or if the
option is TRUE
. For example, the function
utest
sets it to the name of the package
being checked
(_R_CHECK_RUNNING_UTESTS_=<pkgname>
), but unit
tests run as part of unit tests vignettes are run with
_R_CHECK_RUNNING_UTESTS_=FALSE
, so that all tests
are run and reported when generating them.
1 2 3 4 5 |
... |
each argument specifies a set of tests to do using an AND operator. The final result tests if any of the test set is true. Possible values are:
|
Currently isCRANcheck
returns TRUE
if the
check is run with either environment variable
_R_CHECK_TIMINGS_
(as set by flag
'--timings'
) or _R_CHECK_CRAN_INCOMINGS_
(as set by flag '--as-cran'
).
Warning: the checks performed on CRAN check machines are on purpose not always run with such flags, so that users cannot effectively "trick" the checks. As a result, there is no guarantee this function effectively identifies such checks. If really needed for honest reasons, CRAN recommends users rely on custom dedicated environment variables to enable specific tests or examples.
Adapted from the function CRAN
in the fda
package.
https://github.com/renozao/roxygen2
1 | isCHECK()
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.