test.assessr (version 1.1.1)

get_package_coverage: get package test coverage

Description

simplified input to assess package for test coverage

Usage

get_package_coverage(path = NULL)

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 or if the specified path does not exist.

Arguments

path

(optional) path of locally stored package source code

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
get_package_coverage <- get_package_coverage(pkg_source_path)
# }