1 Roxygen documentation guidelines
The scope of this document is to provide opinionated yet motivated guidelines and best practices for documenting R objects (especially functions) with roxygen2.
This is based on:
- roxygen2 vignettes:
browseVignettes("roxygen2"), in particular Generating Rd files.
- The tidyverse style guide.
- Package development experience.
Examples are provided to show the concrete application of the described principles.