R Observatory: Metrics for testthatdocs version 1.0.23

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

testthatdocs

1.0.23

Automated and Idempotent Unit Tests Documentation for Reproducible Quality Assurance

0packages depend

1.4Kdownloads / year

93.2%test coverage

13/13checks pass

Overview

About

Maintained by Rafal UrniazFirst published 2025-10-211 releasesCRAN page ↗GitHub ↗

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.

Install

R (CRAN)pak (dev)Ubuntu (r2u)Fedora (COPR)openSUSE (OBS)

install.packages("testthatdocs", repos = "https://cloud.r-project.org/")

Installs the current CRAN release. Prebuilt binaries on Windows and macOS.

if (!requireNamespace("pak", quietly = TRUE))
  install.packages("pak", repos = "https://cloud.r-project.org/")
pak::pak("urniaz/testthatdocs")

Development version from urniaz/testthatdocs. Installs pak first if it is not already available.

Release

# enable cranapt (r2u) if it is not already set up, then install
grep -rqs r2u.stat.illinois.edu /etc/apt/sources.list /etc/apt/sources.list.d/ \
  || curl -fsSL https://raw.githubusercontent.com/eddelbuettel/r2u/master/inst/scripts/add_cranapt_noble.sh | sudo bash
sudo apt install -y r-cran-testthatdocs

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled.

bspm (used by r2u) also needs make: sudo apt install make

# enable the iucar/cran COPR if it is not already present, then install
ls /etc/yum.repos.d/*iucar*cran*.repo >/dev/null 2>&1 \
  || sudo dnf copr enable -y iucar/cran
sudo dnf install -y R-CRAN-testthatdocs

RPMs from the iucar/cran COPR, rebuilt from CRAN.

For install.packages() integration in R, also: sudo dnf install R-CoprManager

# add the autoCRAN OBS repo (Tumbleweed) if it is missing, then install
zypper -q lr | grep -qi autoCRAN \
  || sudo zypper addrepo https://download.opensuse.org/repositories/devel:/languages:/R:/autoCRAN/openSUSE_Tumbleweed/devel:languages:R:autoCRAN.repo
sudo zypper install -y R-testthatdocs

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed).

Health

CRAN checks

13OK

Slowest check: 1.7 min · r-oldrel-macos-x86_64

Code health

Yes

Tests · ratio 0.65

93.2%

Coverage · measured lines

100%

Documentation · exports

0

Dependencies · direct

Check history

OK2026-08-04
13 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
NOTE2026-08-01
12 OK · 1 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
OK2026-03-10
14 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE

Documentation

READMENoVignettesYes · dynamicpkgdown siteNoNEWSNoCode of conductNoContributing guideNo

Examples that run: 0%
Documented parameters: 100%
Return-value docs: 100%
References docs: 0%

Downloads

1.4K

CRAN downloads in the past year

Rank #23,453 · ~4/day · ~120/mo

Releases R versions

Daily download trend is not available in this view yet.

13330 days

41690 days

1.4K1 year

Compare downloads with other packages →

Also on62 r2u16 autocran

Repository

GitHub ↗ urniaz/testthatdocs

7Stars

0Forks

0Open issues

0Open PRs

1Releases

106Commits

2Contributors

106 commits · Last activity 2026-05-30 · 0% stars, 30d

Stars over time

2025-09-05 · 12026-07-07 · 7

Repository practices

Upstream repositoryBeta

1 development-tooling and community-health practice detected across 1 family in the upstream repository

Checks run against github.com/urniaz/testthatdocs on 2026-08-16.

Continuous integration (1)

GitHub Actions

How this is detected·Detection ruleset v1 (2026-07-18)

Dependencies

Declared dependencies

5 external dependencies (excludes base and recommended)

Depends (1)

R >= 3.5

Imports (0)

none

LinkingTo (0)

none

Suggests (5)

testthat glue knitr rmarkdown withr

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

Code & Tests

People & History

People (1)

Maintainer (1)

Rafal Urniaz

Author, Maintainer

Authors (1)

Rafal Urniaz

Author, Maintainer

Package Timeline

1 release. R releases are shown for context.

R
R 4.6.0 released · 2026-04-24
1.0.23Latest
2026-03-10 · current release
R
R 4.5.0 released · 2025-04-11

Package metadata

First published: 2025-10-21
Total releases: 1 / 1 yrs
License: MIT + file LICENSE OSI
Minimum R: ≥ 3.5
Download size: 326 KB
Installed size: not tracked yet
With dependencies: not tracked yet

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("testthatdocs")

Format

Urniaz, R. (2025). testthatdocs: Automated and Idempotent Unit Tests Documentation for Reproducible Quality Assurance (Version 1.0.23) [Computer software]. https://doi.org/10.32614/CRAN.package.testthatdocs

This is what citation() produces when a package has no citation file of its own. If it prints something else, use that.

Cite the R Observatory

For a number measured here: a download total, a coverage figure, an archival date.

Format

APA

Balamuta, J. J. (2026). R Observatory: Metrics for testthatdocs version 1.0.23 [Data set]. HJJB, LLC. Data release v2026-08-18. https://doi.org/10.5281/zenodo.21843040

From data release v2026-08-18, which the citation names so these numbers can be found later. More on citing and the projects behind them.

Report a problem with this page →