Skip to content

Documentation

Documenting functions

The basics of roxygen2 tags and how to use them for documenting functions.

Documenting other objects

How to document datasets, packages, and the classes, generics, and methods of S3, S4, and R6.

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 NAMESPACE file with roxygen2.

Developer resources

Extending roxygen2