roxygen2

Overview

About

Maintained by Hadley WickhamFirst published 2011-07-2333 releasesCRAN page ↗GitHub ↗

Generate your Rd documentation, 'NAMESPACE' file, and collation field using specially formatted comments. Writing documentation in-line with code makes it easier to keep your documentation up-to-date as your requirements change. 'roxygen2' is inspired by the 'Doxygen' system for C++.

Install

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

install.packages("roxygen2", 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("r-lib/roxygen2")

Development version from r-lib/roxygen2. 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-roxygen2

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

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

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

Health

CRAN checks

13OK

Slowest check: 4.6 min · r-devel-linux-x86_64-fedora-clang

Code health

Yes

Tests · ratio 1.13

94.2%

Coverage · measured lines

100%

Documentation · exports

13

Dependencies · direct

Check history

OK2026-06-08
12 OK · 0 NOTE · 0 WARNING · 0 ERROR · 1 FAILURE
ERROR2026-06-05
12 OK · 0 NOTE · 0 WARNING · 1 ERROR · 0 FAILURE
OK2026-03-25
14 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
ERROR2026-03-22
13 OK · 0 NOTE · 0 WARNING · 1 ERROR · 0 FAILURE
OK2026-03-10
14 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE

Documentation

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

Examples that run: 89%
Documented parameters: 86%
Return-value docs: 27%
References docs: 0%

Downloads

3M

CRAN downloads in the past year

Rank #195 · ~8.3K/day · ~252.9K/mo

Releases R versions

Daily download trend is not available in this view yet.

282.3K30 days

896.7K90 days

3M1 year

Compare downloads with other packages →

Also on109.3K r2u151 autocran246.4K conda_forge1.3K c2d4u

Repository

GitHub ↗ r-lib/roxygen2

655Stars

238Forks

10Open issues

3Open PRs

28Releases

2,789Commits

125Contributors

rdocumentationdevtools

2,789 commits · Last activity 2026-07-21 · +0.9% stars, 30d

Stars over time

2025-07-03 · 6112026-07-20 · 654

Repository practices

Upstream repositoryBeta

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

Checks run against github.com/r-lib/roxygen2 on 2026-07-19.

Continuous integration (1)

GitHub Actions

Reproducibility and dev environment (1)

Dev Container

CRAN release process (2)

cran-comments.mdrevdep/

Lint, format, editor (3)

AirVS CodeRStudio project

Show all practices

Coverage (2)

Codecov.covrignore

Governance and community (1)

Support guide

Git structural (1)

.gitattributes

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

Dependencies

Declared dependencies

19 external dependencies (excludes base and recommended)

Depends (1)

R >= 4.1

Imports (13)

brew cli commonmark desc knitr lifecyclemethodspkgload R6 rlangutilswithr xml2

LinkingTo (1)

cpp11

Suggests (7)

covr R.methodsS3 S7 R.oo rmarkdown testthat yaml

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

500direct

106indirect

and 452 more packages.

Code & Tests

Code Composition

R 21,535 (74%)Vignettes 2,516 (9%)Markdown 2,438 (8%)Rd 1,999 (7%)C++ 631 (2%)Other 145 (0%)

Code characteristics

Object systems

S3232R64

Cyclomatic complexity: 1.0 median / 23 max
Test cases: 618 / 1.13 per code line

Test coverage

Line coverage

94%

Expression

94.7%

Tests / Examples

94.2% / 11% ex

Functions

723 54 exported

Complexity

2.1 avg / 23 max

Call network

723 nodes / 999 edges

Call graph

Open call graph →

Loading call graph…

Lowest coverage

723 functions

Function	Cyclo	Coverage
env_package exp	1	0%
roclet_clean exp	1	0%
roclet_tags exp	1	0%
roxy_tag_warning exp	2	0%
vignette_roclet exp	1	0%
.onLoad	1	0%

People & History

People (5)

Maintainer (1)

Hadley Wickham

Author, Maintainer, Copyright holder

Authors (4)

Hadley Wickham

Author, Maintainer, Copyright holder

Gábor Csárdi

Author · added in 7.0.0

Peter Danenberg

Author, Copyright holder

Manuel Eugster

Author, Copyright holder

Copyright holders (4)

Hadley Wickham

Author, Maintainer, Copyright holder

Peter Danenberg

Author, Copyright holder

Manuel Eugster

Author, Copyright holder

Posit Software, PBC

Copyright holder, Funder · added in 7.3.0

Funders (1)

Posit Software, PBC

Copyright holder, Funder · added in 7.3.0

Listed in earlier versions (1)

RStudio

no longer listed · 4.0.2 to 7.2.3

Package Timeline

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

8.0.0Latest
2026-05-01 · current release · diff ↗
R
R 4.6.0 released · 2026-04-24
7.3.3
2025-09-03 · diff ↗
R
R 4.5.0 released · 2025-04-11
7.3.2
2024-06-28 · diff ↗
R
R 4.4.0 released · 2024-04-24
7.3.1
2024-01-22 · diff ↗
7.3.0
2024-01-11 · diff ↗
R
R 4.3.0 released · 2023-04-21
7.2.3
2022-12-09 · diff ↗
7.2.2
2022-11-11 · diff ↗
7.2.1
2022-07-18 · diff ↗
7.2.0
2022-05-13 · diff ↗
R
R 4.2.0 released · 2022-04-22
7.1.2
2021-09-08 · diff ↗
R
R 4.1.0 released · 2021-05-18

Show 34 earlier events

7.1.1
2020-06-27 · diff ↗
R
R 4.0.0 released · 2020-04-24
7.1.0
2020-03-11 · diff ↗
7.0.2
2019-12-02 · diff ↗
7.0.1
2019-11-22 · diff ↗
7.0.0
2019-11-12 · diff ↗
R
R 3.6.0 released · 2019-04-26
6.1.1
2018-11-07 · diff ↗
6.1.0
2018-07-27 · diff ↗
R
R 3.5.0 released · 2018-04-23
R
R 3.4.0 released · 2017-04-21
6.0.1
2017-02-06 · diff ↗
6.0.0
2017-01-31 · diff ↗
R
R 3.3.0 released · 2016-05-03
5.0.1
2015-11-11 · diff ↗
5.0.0
2015-10-28 · diff ↗
R
R 3.2.0 released · 2015-04-16
4.1.1
2015-04-15 · diff ↗
4.1.0
2014-12-13 · diff ↗
4.0.2
2014-09-02 · diff ↗
4.0.1
2014-05-17 · diff ↗
4.0.0
2014-05-02 · diff ↗
R
R 3.1.0 released · 2014-04-10
3.1.0
2014-01-29 · diff ↗
3.0.0
2013-12-06 · diff ↗
R
R 3.0.0 released · 2013-04-03
R
R 2.15.0 released · 2012-03-30
2.2.2
2011-12-01 · diff ↗
2.2.1
2011-11-19 · diff ↗
2.2
2011-11-12 · diff ↗
R
R 2.14.0 released · 2011-10-31
2.1
2011-07-29 · diff ↗
2.0
2011-07-23
R
R 2.13.0 released · 2011-04-13

Package metadata

First published: 2011-07-23
Total releases: 33 / 15 yrs
License: MIT + file LICENSE OSI
Minimum R: ≥ 4.1
Download size: 296 KB
Installed size: not tracked yet
With dependencies: not tracked yet