R Observatory: Metrics for document version 4.0.1

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

document

4.0.1Package record

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

0packages dependsuggested by 2

7.2Kdownloads / year

38.8%test coverage

13/13flavors OK

Overview

About

Maintained by Andreas Dominik CullmannCRAN 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.

Changes in 4.0.1

Fix missing package anchors in documentation as reported by CRAN.

From NEWS.md in the release

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. 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-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). 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: 2.5 min · r-devel-windows-x86_64

Status changes

OK13 OK2026-08-05
NOTE12 OK, 1 NOTE2026-08-01
OK14 OK2026-03-10

Advisories

none known

How this is measured·How advisories are found

Documentation

In release 4.0.1

READMEYes · 40 wordsVignettesYes · 1 · dynamicNEWSYes · 100% structured · mentions 4.0.1Citation fileNoWebsitenot declared in DESCRIPTION

Help pages: 17 (13 internal)includes a package overview page
Examples that run: 33%1 run in a plain check · 2 only when donttest examples are enabled (R CMD check --as-cran)
Exported functions with examples: 75%
Documented parameters: 100%
Return-value docs: 100%
Help pages citing references: 0%

Vignettes (1)

An Introduction to document HTML

How these are measured

Downloads

7.2K

CRAN downloads in the past year

Rank #6,262 · ~20/day · ~603/mo

Releases R versions

Daily download trend is not available in this view yet.

56730 days

1.3K90 days

7.2K1 year

Compare downloads with other packages →

Also on75 r2u6 autocran

How downloads are counted

Repository

gitlab.com/fvafrcu/document ↗

Responsiveness

not measured

How these are measured

PracticesBeta

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 v3 (2026-09-26)

Dependencies

Declared dependencies

12 external dependencies (excludes base and recommended)

Installing document adds 36 packages (16 with compiled code, 7.7 MB of source tarballs). Heaviest: fs 1.4 MB, rlang 766 KB, curl 714 KB.

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

0direct

0indirect

Suggested by 2

Suggests, most downloaded first

packager shiny.webawesome

How these are counted

Code & Tests

People & History

People (1)

Andreas Dominik Cullmann

Author, Maintainer since 1.0.0 (2017)

Listed in earlier versions (1)

Cullmann

no longer listed · 1.0.0 to 4.0.1

Releases (20)

Pick two releases to compare their code metrics.

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

Show 16 earlier eventsHide 16 earlier events

3.2.0
record
2020-01-11 · diff ↗
R
R 3.6.0 released · 2019-04-26
3.1.0
record
2018-11-25 · diff ↗
3.0.2
record
2018-09-13 · diff ↗
R
R 3.5.0 released · 2018-04-23
3.0.1
record
2018-03-20 · diff ↗
3.0.0
record
2018-02-11 · diff ↗ ·
removed 4 exports
alter_description_file, check_package, clean_description_file, fake_package
2.2.1
record
2018-01-13 · diff ↗ ·
added 1 export
get_lines_between_tags
2.2.0
record
2017-12-09 · diff ↗
2.1.0
record
2017-08-18 · diff ↗ ·
added 2 exports
alter_description_file, clean_description_file
2.0.0
record
2017-08-04 · diff ↗ ·
added 1 export
check_package
1.2.1
record
2017-07-07 · diff ↗
1.2.0
record
2017-06-01 · diff ↗
1.1.0
record
2017-05-19 · diff ↗
1.0.0
record
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

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

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