roxygen2 Documentation

To document R package functions with roxygen2, add code comments above the function definition using tags like @param for parameters, @returns for output values, and @export to generate the corresponding .Rd files automatically.

Documenting R package-level information and datasets requires adding specific roxygen2 tags to your scripts, which generates the necessary .Rd files to ensure your datasets and package overview are discoverable.

The best way to generate examples for R package documentation is using the @examples tag in roxygen2, which embeds executable R code directly within your code comments to demonstrate function usage.

Essential roxygen2 tags for R package documentation include @param for arguments, @returns for outputs, @export for namespace control, and @examples for usage demonstrations.

You can use Markdown for rich text formatting in R package documentation by enabling Markdown support in roxygen2, allowing you to add links, lists, and code blocks within your code comments.