testthatdocs: Automated and Idempotent Unit Tests Documentation for Reproducible Quality Assurance

Automates documentation of test_that() calls within R test files. The package scans test sources, extracts human-readable test titles (even when composed with functions like paste() or glue::glue(), ... etc.), and generates reproducible roxygen2-style listings that can be inserted both globally and per-section. It ensures idempotent updates and supports customizable numbering templates with hierarchical indices. Designed for developers, QA teams, and package maintainers seeking consistent, self-documenting test inventories.

Version:	1.0.23
Depends:	R (≥ 3.5)
Suggests:	testthat (≥ 3.0.0), glue, knitr, rmarkdown, withr
Published:	2025-10-21
DOI:	10.32614/CRAN.package.testthatdocs
Author:	Rafal Urniaz [aut, cre]
Maintainer:	Rafal Urniaz <rafal.urniaz at cantab.net>
BugReports:	https://github.com/urniaz/testthatdocs/issues
License:	MIT + file LICENSE
URL:	https://github.com/urniaz/testthatdocs
NeedsCompilation:	no
CRAN checks:	testthatdocs results

Documentation:

Reference manual:	testthatdocs.html , testthatdocs.pdf
Vignettes:	Introduction to Idempotent Test Listings for testthat: Global and Section Lists (source, R code) Quick Start: Generating Idempotent test_that() Listings with Sections (source, R code)

Downloads:

Package source:	testthatdocs_1.0.23.tar.gz
Windows binaries:	r-devel: not available, r-release: not available, r-oldrel: testthatdocs_1.0.23.zip
macOS binaries:	r-release (arm64): testthatdocs_1.0.23.tgz, r-oldrel (arm64): testthatdocs_1.0.23.tgz, r-release (x86_64): testthatdocs_1.0.23.tgz, r-oldrel (x86_64): testthatdocs_1.0.23.tgz

Linking:

Please use the canonical form https://CRAN.R-project.org/package=testthatdocs to link to this page.