roxygen2 Documentation

What problem does it solve?

This Skill provides a comprehensive guide to documenting R packages using roxygen2, ensuring your code is understandable, maintainable, and discoverable by users and other developers.

Core Features & Use Cases

• Roxygen Tag Reference: Detailed explanations of essential tags like @param, @returns, @export, @examples, and more.
• Markdown Integration: Learn how to use Markdown for rich text formatting, links, and code blocks within your documentation.
• Data and Package-Level Docs: Understand how to document datasets and the package itself for a complete documentation suite.
• Use Case: You've written a new R function and need to document it correctly for your package. This Skill will guide you through adding parameters, return values, examples, and export tags to generate professional .Rd files.

Quick Start

Use the roxygen2 documentation skill to learn how to document an R function with parameters and return values.