Document Unit Tests Roxygen-Style
Overview
Much as 'roxygen2' allows one to document functions in the same file as the function itself, 'roxut' allows one to write the unit tests in the same file as the function. Once processed, the unit tests are moved to the appropriate directory. Currently supports 'testthat' and 'tinytest' frameworks. The 'roxygen2' package provides much of the infrastructure.
Bugs
- The unit test files were missing a comment marker on Windows (in spite of passing all tests on Win-Builder; reported by Vilmantas Gegzna).
Improvements
- Much more robust unit tests were added. See
tests_roclet.R. - Unit test files now have a line giving the location of the unit test in the original file. Helpful if a
*.Rfile contains more than one function with unit tests. Suggested with initial code by Claudia Beleites (was actually added in the previous version).
From NEWS.md in the release
Install
Health
- OK13 OK2026-08-04
- NOTE12 OK, 1 NOTE2026-08-01
- OK13 OK2026-06-09
- ERROR12 OK, 1 ERROR2026-06-08
- OK14 OK2026-03-10
Documentation
- Help pages
- 6includes a package overview page
- Examples that run
- 100%1 run in a plain check
- Exported functions with examples
- 100%
- Documented parameters
- not tracked
- Return-value docs
- 100%
- Help pages citing references
- 0%
Downloads
Repository
- PRs merged (all time)
- 100%
- Median days to close, 50 most recently updated closed issues
- 1
- Median days to close, 50 most recently updated closed PRs
- 4
Stars over time
Forks over time
Issues over time
PRs over time
5 development-tooling and community-health practices detected across 2 families in the upstream repository
Checks run against github.com/bryanhanson/roxut on 2026-10-18.
The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel
GitHub Pages site last deployed 2022-12-12 · The repository has a site deploy workflow
Dependencies
Installing roxut adds 26 packages (12 with compiled code, 5.8 MB of source tarballs). Heaviest: fs 1.4 MB, rlang 766 KB, cli 629 KB.
Code & Tests
People & History
Package metadata
- First published
- 2020-07-06
- Total releases
- 4 / 6 yrs
- License
- GPL-3 OSI
- Download size
- 9.2 KB
Cite
Cite this package
Run in R for the authors' preferred citation:
citation("roxut")This package has no citation file, so citation() returns this entry built from DESCRIPTION.
Cite the R Observatory
For a number measured here: a download total, a coverage figure, an archival date.
From data release v2026-10-22, which the citation names so these numbers can be found later. More on citing and the projects behind them.