R Observatory: Metrics for documenter version 0.1.3

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

documenter

0.1.3

Documents Files

0packages depend

2.4Kdownloads / year

40.5%test coverage

13/13checks pass

Overview

About

Maintained by Zachary ColburnFirst published 2019-03-023 releasesCRAN page ↗

It is sometimes necessary to create documentation for all files in a directory. Doing so by hand can be very tedious. This task is made fast and reproducible using the functionality of 'documenter'. It aggregates all text files in a directory and its subdirectories into a single word document in a semi-automated fashion.

Install

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

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

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

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

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

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

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

Health

CRAN checks

13OK

Slowest check: 1.2 min · r-release-macos-x86_64

Code health

Yes

Tests · ratio 0.54

40.5%

Coverage · measured lines

100%

Documentation · exports

4

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-06-09
13 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
ERROR2026-06-08
12 OK · 0 NOTE · 0 WARNING · 1 ERROR · 0 FAILURE
OK2026-03-10
14 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE

Documentation

READMEYes · 90 wordsVignettesYes · dynamicpkgdown siteNoNEWSYes · 67% structuredCode of conductNoContributing guideNo

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

Downloads

2.4K

CRAN downloads in the past year

Rank #18,654 · ~6/day · ~197/mo

Releases R versions

Daily download trend is not available in this view yet.

17430 days

59590 days

2.4K1 year

Compare downloads with other packages →

Also on105 r2u9 autocran1.1K conda_forge

Dependencies

Declared dependencies

8 external dependencies (excludes base and recommended)

Depends (0)

none

Imports (4)

officer magrittr htmltools yaml

LinkingTo (0)

none

Suggests (4)

covr testthat knitr rmarkdown

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

Code & Tests

People & History

People (2)

Maintainer (1)

Zachary Colburn

Author, Maintainer

Authors (1)

Zachary Colburn

Author, Maintainer

Copyright holders (1)

Madigan Army Medical Center - Department of Clinical Investigation

Copyright holder, Funder

Funders (1)

Madigan Army Medical Center - Department of Clinical Investigation

Copyright holder, Funder

Package Timeline

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

R
R 4.6.0 released · 2026-04-24
R
R 4.5.0 released · 2025-04-11
R
R 4.4.0 released · 2024-04-24
R
R 4.3.0 released · 2023-04-21
0.1.3Latest
2023-01-05 · current release · diff ↗
0.1.2
2022-04-26 · diff ↗
R
R 4.2.0 released · 2022-04-22
R
R 4.1.0 released · 2021-05-18
R
R 4.0.0 released · 2020-04-24
R
R 3.6.0 released · 2019-04-26
0.1.1
2019-03-02
R
R 3.5.0 released · 2018-04-23

Package metadata

First published: 2019-03-02
Total releases: 3 / 7 yrs
License: MIT + file LICENSE OSI
Download size: 27 KB
Installed size: not tracked yet
With dependencies: not tracked yet

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("documenter")

Format

Colburn, Z., & Madigan Army Medical Center - Department of Clinical Investigation. (2023). documenter: Documents Files (Version 0.1.3) [Computer software]. https://doi.org/10.32614/CRAN.package.documenter

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

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