| testInstalledPackage {tools} | R Documentation |
These functions allow an installed package to be tested, or all base and recommended packages.
testInstalledPackage(pkg, lib.loc = NULL, outDir = ".",
types = c("examples", "tests", "vignettes"),
srcdir = NULL, Ropts = "")
testInstalledPackages(outDir = ".", errorsAreFatal = TRUE,
scope = c("both", "base", "recommended"),
types = c("examples", "tests", "vignettes"),
srcdir = NULL, Ropts = "")
testInstalledBasic(scope = c("basic", "devel", "both"))
pkg |
name of an installed package. |
lib.loc |
library path(s) in which to look for the package. See
|
outDir |
the directory into which to write the output files: this should already exist. |
types |
type(s) of tests to be done. |
errorsAreFatal |
logical: should testing terminate at the first error? |
srcdir |
Optional directory to look for |
Ropts |
Additional options such as -d valgrind to be
passed to |
scope |
Which set(s) should be tested? |
These tests depend on having the package example files installed (which
is the default). If package-specific tests are found in a
‘tests’ directory they can be tested: these are not
installed by default, but will be if
R CMD INSTALL --install-tests was used. Finally, the R
code in any vignettes can be extracted and tested.
Package tests are run in a ‘pkg-tests’ subdirectory of ‘outDir’, and leave their output there.
testInstalledBasic runs the basic tests, if installed. This
should be run with LC_COLLATE=C set: the function tries to set
this by it may not work on all OSes. For non-English locales it may
be desirable to set environment variables LANGUAGE to en
and LC_TIME to C to reduce the number of differences from
reference results.
The package-specific tests for the base and recommended packages are
an optional part of the install.
Currently testing requires a Unix-like diff for a full report
if more than simple differences are found.
Invisibly 0L for success, 1L for failure.