r-lib / roxygen2

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 files in , , and, if needed, the field in . 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 directory. Here's a simple example from the stringr package: When you (or ) your package these comments will be automatically transformed to the that R uses to generate the documentation you see when you type . Learn more To get started, first read . Then read more about the specific package component that you want to generate: • Start with to learn how document your functions with roxygen2. • discusses how to document other things like datasets, the package itself, and the various pieces used by R's OOP systems. • gives the details of roxygen2's rmarkdown support. • demonstrates the tools available to reuse documentation in multiple places. • describes how to generate a file, how namespacing works in R, and how you can use roxygen2 to be specific about what your package needs and supplies. • For the field in the , see .