R Observatory: Metrics for document version 4.0.1

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

document

4.0.1

Run 'roxygen2' on (Chunks of) Single Code Files

2packages depend

7.5Kdownloads / year

38.8%test coverage

13/13checks pass

Overview

About

Maintained by Andreas Dominik CullmannFirst published 2017-05-0820 releasesCRAN page ↗GitLab ↗

Have you ever been tempted to create 'roxygen2'-style documentation comments for one of your functions that was not part of one of your packages (yet)? This is exactly what this package is about: running 'roxygen2' on (chunks of) a single code file.

Install

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

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

Development version from fvafrcu/document. 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-document

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

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

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

Health

CRAN checks

13OK

Slowest check: 2.4 min · r-release-windows-x86_64

Code health

Yes

Tests · ratio 0.51

38.8%

Coverage · measured lines

100%

Documentation · exports

7

Dependencies · direct

Check history

OK2026-08-05
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

READMEYes · 40 wordsVignettesYes · dynamicpkgdown siteNoNEWSYes · 100% structuredCode of conductNoContributing guideNo

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

Downloads

7.5K

CRAN downloads in the past year

Rank #5,907 · ~20/day · ~622/mo

Releases R versions

Daily download trend is not available in this view yet.

24030 days

1.4K90 days

7.5K1 year

Compare downloads with other packages →

Also on104 r2u8 autocran

Repository

GitLab ↗ fvafrcu/document

Repository practices

Upstream repositoryBeta

Repository gitlab.com/fvafrcu/document is linked, but repository-practices checks have not run for it yet. Checks are GitHub-only for now.

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

Dependencies

Declared dependencies

12 external dependencies (excludes base and recommended)

Depends (1)

R >= 3.3.0

Imports (7)

callr checkmate desc fritools rcmdcheck roxygen2 rstudioapi

LinkingTo (0)

none

Suggests (5)

knitr pkgload rmarkdown RUnit testthat

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

2direct

0indirect

packager shiny.webawesome

Code & Tests

People & History

People (1)

Maintainer (1)

Andreas Dominik Cullmann

Author, Maintainer

Authors (1)

Andreas Dominik Cullmann

Author, Maintainer

Listed in earlier versions (1)

Cullmann

no longer listed · 1.0.0 to 4.0.1

Package Timeline

20 releases. Pick two to compare their code metrics. R releases are shown for context.

R
R 4.6.0 released · 2026-04-24
4.0.1Latest
2025-05-25 · current release · diff ↗
R
R 4.5.0 released · 2025-04-11
R
R 4.4.0 released · 2024-04-24
4.0.0
2023-06-14 · diff ↗
unarchivedReturned to CRAN
2023-06-14
R
R 4.3.0 released · 2023-04-21
archivedRemoved from CRAN
2022-09-04
requires archived package 'fritools'
3.3.4
2022-08-19 · diff ↗
R
R 4.2.0 released · 2022-04-22
3.3.3
2022-03-30 · diff ↗
R
R 4.1.0 released · 2021-05-18
3.3.2
2021-05-12 · diff ↗
3.3.1
2021-03-31 · diff ↗
3.3.0
2020-10-30 · diff ↗
R
R 4.0.0 released · 2020-04-24

Show 16 earlier events

3.2.0
2020-01-11 · diff ↗
R
R 3.6.0 released · 2019-04-26
3.1.0
2018-11-25 · diff ↗
3.0.2
2018-09-13 · diff ↗
R
R 3.5.0 released · 2018-04-23
3.0.1
2018-03-20 · diff ↗
3.0.0
2018-02-11 · diff ↗
2.2.1
2018-01-13 · diff ↗
2.2.0
2017-12-09 · diff ↗
2.1.0
2017-08-18 · diff ↗
2.0.0
2017-08-04 · diff ↗
1.2.1
2017-07-07 · diff ↗
1.2.0
2017-06-01 · diff ↗
1.1.0
2017-05-19 · diff ↗
1.0.0
2017-05-08
R
R 3.4.0 released · 2017-04-21

Package metadata

First published: 2017-05-08
Total releases: 20 / 9 yrs
License: BSD_2_clause + file LICENSE OSI
Minimum R: ≥ 3.3.0
Download size: 33 KB
Installed size: not tracked yet
With dependencies: not tracked yet

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("document")

Format

Cullmann, A. D. (2025). document: Run 'roxygen2' on (Chunks of) Single Code Files (Version 4.0.1) [Computer software]. https://doi.org/10.32614/CRAN.package.document

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 document version 4.0.1 [Data set]. HJJB, LLC. Data release v2026-08-15. https://doi.org/10.5281/zenodo.21843040

From data release v2026-08-15, 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 →