{"repo":"r-lib/roxygen2","free":true,"listed":false,"github":"https://github.com/r-lib/roxygen2","clone":"git clone https://github.com/r-lib/roxygen2.git","description":"Generate R package documentation from inline R comments","language":"R","stars":662,"topics":["r","documentation","devtools"],"license":null,"category":"docs-static-sites","readme_excerpt":"roxygen2 The premise of roxygen2 is simple: describe your functions in comments next to their definitions and roxygen2 will process your source code and comments to automatically generate .Rd files in man/ , NAMESPACE , and, if needed, the Collate field in DESCRIPTION . Installation Usage The premise of roxygen2 is simple: describe your functions in comments next to their definitions and roxygen2 will process your source code and comments to produce Rd files in the man/ directory. Here's a simple example from the stringr package: When you roxygenise() (or devtools::document() ) your package these comments will be automatically transformed to the .Rd that R uses to generate the documentation you see when you type ?str length . Learn more To get started, first read vignette(\"roxygen2\") . Then read more about the specific package component that you want to generate: vignette(\"rd-functions\") describes how to document your functions with roxygen2. vignette(\"rd-S3\") , vignette(\"rd-S4\") , vignette(\"rd-R6\") , and vignette(\"rd-S7\") discuss documenting the various OOP systems. vignette(\"rd-datasets\") and vignette(\"rd-packages\") cover documenting datasets and the package itself. vignette(\"rd-formatting\") gives the details of roxygen2's rmarkdown support. vignette(\"reuse\") demonstrates the tools available to reuse documentation in multiple places. vignette(\"namespace\") describes how to generate a NAMESPACE file, how namespacing works in R, and how you can use roxygen2 to be specific abou","default_branch":null,"files":null,"tree":[],"storefront":"/r/r-lib","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/r-lib/roxygen2/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}