Skip to content

Rd2roxygen

1.18Package record

Convert Rd to 'Roxygen' Documentation

0packages dependsuggested by 1
9.8Kdownloads / year
–test coverage
13/13flavors OK

Overview

About

Functions to convert Rd to 'roxygen' documentation. It can parse an Rd file to a list, create the 'roxygen' documentation and update the original R script (e.g. the one containing the definition of the function) accordingly. This package also provides utilities that can help developers build packages using 'roxygen' more easily. The 'formatR' package can be used to reformat the R code in the examples sections so that the code will be more readable.

Changes in 1.18
  • Switched the package vignette engine from knitr to litedown.

From NEWS.md in the release

Install

Health

CRAN checks
13OK
Slowest check: 1.1 min · r-release-macos-x86_64
Status changes
  • OK13 OK2026-08-05
  • NOTE12 OK, 1 NOTE2026-08-01
  • OK14 OK2026-03-10
Advisories

none known

Documentation

In release 1.18
READMEYes · 20 wordsVignettesYes · 1 · dynamicNEWSYes · 100% structured · mentions 1.18Citation fileNoWebsitenot declared in DESCRIPTION
Help pages
7includes a package overview page
Examples that run
67%4 run in a plain check · 1 never run · 1 hold no code
Exported functions with examples
83%
Documented parameters
100%
Return-value docs
100%
Help pages citing references
0%

Downloads

9.8K
CRAN downloads in the past year
Rank #5,123 · ~27/day · ~814/mo
Daily download trend is not available in this view yet.
58730 days
1.6K90 days
9.8K1 year
Compare downloads with other packages →
Also on111 r2u1 autocran

Repository

31Stars
15Forks
4Open issues
0Open PRs
9Releases
389Commits
5Commit identities
rroxygen-documentation
389 commits · Last activity 2026-10-19 · 0% stars, 30d · Default branch at 1.18.1, ahead of CRAN 1.18 (checked 2026-10-21)
Responsiveness
How these are sampled
PRs merged (all time)
71%
Median days to close, 50 most recently updated closed issues
2
Median days to close, 50 most recently updated closed PRs
2

Stars over time

2024-05-07 · 312026-07-07 · 31
PracticesBeta

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

Checks run against github.com/yihui/rd2roxygen on 2026-10-21.

Continuous integration (2)
GitHub ActionsR CMD check workflow

The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel

Governance and community (1)

The repository owner accepts GitHub Sponsors

Automation and maintenance (1)
Dependabot
Lint, format, editor (1)
RStudio project
How this is detected·Detection ruleset v4 (2026-10-20)

Dependencies

Declared dependencies
4 external dependencies (excludes base and recommended)

Installing Rd2roxygen adds 27 packages (12 with compiled code, 5.9 MB of source tarballs). Heaviest: fs 1.4 MB, rlang 766 KB, cli 629 KB.

Depends (0)
none
LinkingTo (0)
none
Suggests (1)
Enhances (0)
none
Reverse dependencies
0direct
0indirect
Suggested by 1
Suggests, most downloaded first

People & History

People (2)
Author, Maintainer since 0.1-0 (2010)
Releases (37)

Pick two releases to compare their code metrics.

Show 39 earlier eventsHide 39 earlier events

Package metadata

First published
2010-12-01
Total releases
37 / 16 yrs
License
GPL
Download size
21 KB

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("Rd2roxygen")
Xie, Y., & Wickham, H. (2026). Rd2roxygen: Convert Rd to 'Roxygen' Documentation (Version 1.18) [Computer software]. https://doi.org/10.32614/CRAN.package.Rd2roxygen

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.

APA

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

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

Privacy choices

These apply to this browser and are stored on this device only. Nothing about your choice is sent to us.

Read the privacy policy