roxygen <img class="emoji" alt="heart" src="https://cdn.jsdelivr.net/gh/qinwf/awesome-R@3c66da6e291bcc0520b1649125b0bed750896a9a/heart.png" height="20" align="absmiddle" width="20">
Generate R package documentation and NAMESPACE files from inline R comments.
What is roxygen <img class="emoji" alt="heart" src="https://cdn.jsdelivr.net/gh/qinwf/awesome-R@3c66da6e291bcc0520b1649125b0bed750896a9a/heart.png" height="20" align="absmiddle" width="20">?
roxygen2 is an R package that generates documentation for R packages from inline comments in source code. It automates the creation of Rd files, NAMESPACE, and Collate fields, solving the problem of maintaining manual documentation that often falls out of sync with code.
R package developers and maintainers who need to produce and manage documentation efficiently, particularly those working on CRAN or Bioconductor packages.
Developers choose roxygen2 because it integrates documentation directly into the development workflow, reduces boilerplate, ensures consistency, and is widely adopted in the R community as the standard tool for package documentation.
Overview
Generate R package documentation from inline R comments
Use Cases
Best For
- Automating documentation for R packages with many functions
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
