R Observatory: Metrics for roxyreqs version 1.3.0

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

roxyreqs

1.3.0Package record

'roxygen2'-Style Metadata for Test Cases and Function Documentation

0packages depend

735downloads / year

87.2%test coverage

13/13flavors OK

Overview

About

Maintained by Moritz LangCRAN page ↗GitHub ↗Issues ↗

Extends 'roxygen2' to support '@meta' tags for documenting 'testthat' test cases and function specifications. Includes a custom 'JUnit' reporter that exports test metadata as XML properties and validation functions to ensure all exported functions and tests contain required tags. Designed for traceability between requirements and tests in regulated industries such as pharma and finance.

Changes in 1.3.0

First public release on GitHub and CRAN.
@meta tags for test cases and function documentation.
JunitReporterMeta exports test metadata to JUnit XML.
check_meta*() functions validate required metadata in tests and .Rd files.

From NEWS.md in the release

Install

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

install.packages("roxyreqs", 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("mnlang/roxyreqs")

Development version from mnlang/roxyreqs. 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-roxyreqs

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled. We list this channel from recorded r2u download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

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-roxyreqs

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-roxyreqs

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed). We list this channel from recorded autoCRAN download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

Health

CRAN checks

13OK

CRAN check page ↗

Slowest check: 1.2 min · r-devel-windows-x86_64

Status changes

OK13 OK2026-08-04
NOTE12 OK, 1 NOTE2026-08-01
OK5 OK2026-07-16

Advisories

none known

How this is measured·How advisories are found

Documentation

In release 1.3.0

README· In the repository, left out of the releaseVignettesNoNEWSYes · 67% structured · mentions 1.3.0Citation fileNoWebsitenot declared in DESCRIPTION

Help pages: 6 (1 internal)includes a package overview page
Examples that run: 0%1 never run
Exported functions with examples: 25%
Documented parameters: 85%
Return-value docs: 75%
Help pages citing references: 0%

How these are measured

Downloads

735

CRAN downloads in the past year

Rank #20,179 · ~2/day · ~61/mo

Releases R versions

Daily download trend is not available in this view yet.

22730 days

65290 days

7351 year

Compare downloads with other packages →

Also on16 r2u3 autocran

How downloads are counted

Repository

mnlang/roxyreqs ↗Account: mnlang

4Stars

0Forks

0Open issues

0Open PRs

0Releases

2Commits

2Commit identities

License file reads as GPL-3.0 · 2 commits · Last activity 2026-07-06 · 0% stars, 30d

Responsiveness

not measured

Stars over time

2026-07-16 · 12026-07-25 · 4

How these are measured

PracticesBeta

4 development-tooling and community-health practices detected across 4 families in the upstream repository

Checks run against github.com/mnlang/roxyreqs on 2026-10-18.

Continuous integration (1)

GitHub Actions

Governance and community (1)

Contributing guide

CRAN release process (1)

cran-comments.md

Lint, format, editor (1)

lintr

How this is detected·Detection ruleset v3 (2026-09-26)

Dependencies

Declared dependencies

10 external dependencies (excludes base and recommended)

Installing roxyreqs adds 37 packages (19 with compiled code, 21 MB of source tarballs). Heaviest: stringi 11 MB, fs 1.4 MB, jsonlite 1.0 MB.

Depends (1)

R >= 4.1.0

Imports (8)

brio cli R6 rlang roxygen2 stringr testthat withr

LinkingTo (0)

none

Suggests (2)

spelling xml2

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

How these are counted

Code & Tests

People & History

People (4)

Moritz Lang

Author, Maintainer since 1.3.0 (2026)

Mario Annau

Author

Doug Kelkhoff

Contributor

Szymon Maksymiuk

Contributor

Releases (1)

1.3.0Latest
record
2026-07-15 · current release
R
R 4.6.0 released · 2026-04-24

Package metadata

First published: 2026-07-15
Total releases: 1 / 1 yrs
License: GPL (>= 3) OSI
Minimum R: ≥ 4.1.0
Download size: 18 KB

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("roxyreqs")

Format

Lang, M., Annau, M., Kelkhoff, D., & Maksymiuk, S. (2026). roxyreqs: 'roxygen2'-Style Metadata for Test Cases and Function Documentation (Version 1.3.0) [Computer software]. https://doi.org/10.32614/CRAN.package.roxyreqs

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.

Format

APA

Balamuta, J. J. (2026). R Observatory: Metrics for roxyreqs version 1.3.0 [Data set]. HJJB, LLC. Data release v2026-10-21. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-21, 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 →