generate_test_report: Generate HTML Report for Package Test Assessment

View source: R/generate_test_report.R

generate_test_reportR Documentation

Generate HTML Report for Package Test Assessment

Description

Generates an HTML report for the package test assessment results using rmarkdown.

Usage

generate_test_report(test_results, output_dir = NULL)

Arguments

test_results

List containing the results from get_package_coverage function.

output_dir

(required) Character string path to an existing directory where the report will be saved.

Value

Path to the generated HTML report.

Examples

## Not run: 
test_results <- get_package_coverage()
# Always provide a directory; tempdir() is convenient in examples.
generate_test_report(test_results, output_dir = tempdir())

## End(Not run)

test.assessr documentation built on March 3, 2026, 1:06 a.m.