Package: testthatdocs 1.0.23

Rafal Urniaz

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.

Authors:Rafal Urniaz [aut, cre]

testthatdocs_1.0.23.tar.gz
testthatdocs_1.0.23.zip(r-4.7-any)testthatdocs_1.0.23.zip(r-4.6-any)testthatdocs_1.0.23.zip(r-4.5-any)
testthatdocs_1.0.23.tgz(r-4.6-any)testthatdocs_1.0.23.tgz(r-4.5-any)
testthatdocs_1.0.23.tar.gz(r-4.7-any)testthatdocs_1.0.23.tar.gz(r-4.6-any)
testthatdocs_1.0.23.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION
card.svg |card.png
testthatdocs/json (API)

# Install 'testthatdocs' in R:
install.packages('testthatdocs', repos = c('https://urniaz.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/urniaz/testthatdocs/issues

On CRAN:

Conda:

5.48 score 6 stars 205 downloads 2 exports 0 dependencies

Last updated from:8b43e18323. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-develOK98
source / vignettesOK140
linux-releaseOK91
macos-releaseOK103
macos-oldrelOK69
windows-develOK71
windows-releaseOK69
windows-oldrelOK70
wasm-releaseOK80

Exports:documentdocument_file

Dependencies:

Introduction to Idempotent Test Listings for testthat: Global and Section Lists
Overview | Key Concepts | Sections | Markers and Items | Titles: Raw but Clean | Numbering Templates | document_file() | Arguments | Return Value | Example | document() | Idempotency Guarantees | Edge Cases & Notes | Troubleshooting | Performance Tips | CI Integration | Reproducible Example

Last update: 2025-10-30
Started: 2025-10-30

Quick Start: Generating Idempotent test_that() Listings with Sections
Overview | Quick Start

Last update: 2025-10-30
Started: 2025-10-30