R: Calculate test coverage for a package

package_coverage {covr} | R Documentation

## Calculate test coverage for a package

### Description

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.

### Usage

    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)

### Arguments

`path` | file path to the package.
`type` | run the package ‘tests’, ‘vignettes’, ‘examples’, ‘all’, or ‘none’. The default is ‘tests’.
`combine_types` | If `TRUE` (the default) the coverage for all types is simply summed into one coverage object. If `FALSE` separate objects are used for each type of coverage.
`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 `print\.` to match print methods.
`code` | A character vector of additional test code to run.
`...` | Additional arguments passed to `testInstalledPackage`.
`exclusions` | ‘Deprecated’, please use ‘line_exclusions’ instead.

### Details

This function uses `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.

### See Also

`exclusions` For details on excluding parts of the package from the coverage calculations.

[Package covr version 3.0.1 Index]