get_source_test_mapping_nstf: Map R Source Files to Corresponding Test Files

In test.assessr: Assessing Package Test Reliability and Quality

Map R Source Files to Corresponding Test Files

Description

This internal NSTF utility scans the package's 'R/' directory and the specified test directory and attempts to match each source file with a corresponding test file. Matching is based on filename similarity between source files and test files (case-insensitive, substring matching).

Usage

get_source_test_mapping_nstf(pkg_source_path, test_dir)

Arguments

pkg_source_path	Character string. Path to the root directory of the package source.
test_dir	Character string. Path to the directory containing test files (typically '"tests/"', '"tests/testthat/"', or '"tests/testit/"').

Details

The function is intended for lightweight structural checks in NSTF workflows and does not interpret test contents.

Value

A base R 'data.frame' containing two columns:

* **source_file** — Name of the '.R' file found in the 'R/' directory * **test_file** — Name of the matched test file from 'test_dir', or 'NA' if no matching file is found

The mapping shows which source files have corresponding tests and which do not, enabling automated checks for test completeness in NSTF pipelines.

Output Meaning

A row with 'test_file = NA' indicates that no test file appears to match the given source file. The returned data frame is solely a structural mapping; no tests are run, and no side effects occur.

See Also

Other nstf_utility: check_covr_skip_nstf(), check_covr_skip_testit(), get_nstf_test_path(), run_covr_skip_nstf()

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