This function calculates the test coverage for a development package on the
path
. By default it runs only the package tests, but it can also run
vignette and example code.
package_coverage( path = ".", type = c("tests", "vignettes", "examples", "all", "none"), combine_types = TRUE, relative_path = TRUE, quiet = TRUE, clean = TRUE, line_exclusions = NULL, function_exclusions = NULL, code = character(), ..., exclusions, pre_clean = TRUE )
path | file path to the package. |
---|---|
type | run the package ‘tests’, ‘vignettes’, ‘examples’, ‘all’, or ‘none’. The default is ‘tests’. |
combine_types | If |
relative_path | whether to output the paths as relative or absolute paths. |
quiet | whether to load and compile the package quietly, useful for debugging errors. |
clean | whether to clean temporary output files after running, mainly useful for debugging errors. |
line_exclusions | a named list of files with the lines to exclude from each file. |
function_exclusions | a vector of regular expressions matching function
names to exclude. Example |
code | A character vector of additional test code to run. |
... | Additional arguments passed to |
exclusions | ‘Deprecated’, please use ‘line_exclusions’ instead. |
pre_clean | whether to delete all objects present in the src directory before recompiling |
This function uses tools::testInstalledPackage()
to run the
code, if you would like to test your package in another way you can set
type = "none"
and pass the code to run as a character vector to the
code
parameter.
Parallelized code using parallel's mcparallel()
needs to
use a patched parallel:::mcexit
. This is done automatically if the
package depends on parallel, but can also be explicitly set using the
environment variable COVR_FIX_PARALLEL_MCEXIT
or the global option
covr.fix_parallel_mcexit
.
exclusions()
For details on excluding parts of the
package from the coverage calculations.