Skip to contents

get package test coverage

Source: R/get_package_coverage.R
get_package_coverage.Rd

simplified input to assess package for test coverage

Usage

get_package_coverage(path = NULL, package_installed = NULL)

Arguments

path

(optional) path to locally stored package source code. If package_installed = TRUE, path must point to the unpacked local package directory (the package root containing files such as DESCRIPTION), not to a source tarball such as .tar.gz.

package_installed

(optional) logical flag that controls local package installation. If TRUE, install_package_local is skipped and path is used directly. If NULL or FALSE, a local package installation is attempted.

Value

An object of class "coverage" as produced by test.assessr::run_covr_modes(). This object is a structured list containing detailed test coverage information, including:

  • File-level coverage: percentage of lines covered in each file.

  • Line-by-line coverage: number of executions for each line.

  • Overall coverage: aggregated coverage across the package.

  • Metadata: source file paths, expressions, and summary stats.

The resulting object can be printed, summarized, or passed to test.assessr::generate_test_report() to produce a human-readable test coverage report.

Returns NULL if the package cannot be installed, if install_list$pkg_source_path is missing/empty, or if the specified path does not exist.

Examples

# \donttest{
# Example STF package included in test.assessr
pkg_source_path <- system.file(
  "test-data",
  "test.package.0001_0.1.0.tar.gz",
  package = "test.assessr"
)

# Run get_package_coverage
pkg_test_coverage <- get_package_coverage(pkg_source_path)
#> unpacking test.package.0001 locally
#> unpacked test.package.0001 locally
#> installing test.package.0001 locally
#> test.package.0001 installed locally
#> checking package test config
#> decider: testthat -> run_coverage()
#> running code coverage for test.package.0001
#> code coverage for test.package.0001 successful
#> Cleaning coverage workspace for test.package.0001
#> No safe roots found for orphan cleanup; skipping.
# }