
Articles
Documentation
- Documenting functions
The basics of roxygen2 tags and how to use them for documenting functions.
- Documenting S3
How to document S3 generics, methods, and classes.
- Documenting S4
How to document S4 generics, methods, and classes.
- Documenting R6
How to document R6 classes, methods, and fields.
- Documenting S7
How to document S7 generics, methods, and classes.
- Documenting datasets
How to document datasets stored in
data/.- Documenting packages
How to document a package as a whole using the
"_PACKAGE"sentinel.- Reusing documentation
Tools for reusing documentation across topics, and between documentation and vignettes.
- Indexing and cross-references
Make it easier for users to find your functions by cross-referencing them and control their indexing.
- (R)Markdown support
The details of the (R)Markdown support provided by roxygen2.
NAMESPACE
- Managing imports and exports
Generating the
NAMESPACEfile with roxygen2.