How do I enable Markdown in my R documentation?

You can enable Markdown by adding 'Roxygen: list(markdown = TRUE)' to your package's DESCRIPTION file, which this skill helps you configure.

How do I document S3 and S4 methods?

The skill provides specific roxygen2 tags like @exportS3Method, @slot, and @exportClass to ensure object-oriented code is documented correctly.

Can this skill help with complex parameter documentation?

Yes, it provides patterns for documenting lists, data frames with specific columns, and using describe blocks for structured parameter details.

Does it support automated site deployment?

Yes, the skill includes a complete GitHub Actions YAML configuration to build and deploy your pkgdown site to GitHub Pages automatically.

R Package Documentation (roxygen2 & pkgdown)

Name: R Package Documentation (roxygen2 & pkgdown)
Author: choxos

bychoxos

0•

Learning & Documentation

Streamlines R package documentation and website generation using roxygen2 syntax and pkgdown configurations.

This skill provides a comprehensive reference and implementation guide for documenting R packages using industry-standard tools. It covers everything from basic roxygen2 tags for functions and parameters to advanced features like S3/S4 method documentation, inheritance, and cross-referencing. Additionally, it provides detailed patterns for configuring and styling pkgdown websites, organizing reference indices, and setting up automated deployments via GitHub Actions, making it an essential tool for R developers aiming to create professional-grade, accessible package documentation.

Key Features

01Automated GitHub Actions deployment workflows for documentation sites

02Detailed pkgdown site configuration for custom branding and organization

03Comprehensive roxygen2 tag reference for functions, data, and classes

04S3/S4 method and class documentation patterns

050 GitHub stars

06Advanced cross-referencing for internal and external package links

Use Cases

01Automating R package site updates using CI/CD pipelines

02Building and styling a searchable documentation website for an R library

03Writing CRAN-compliant inline documentation for R packages

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add choxos/tidyrmodelling roxygen2-pkgdown

For use in Claude.ai and ChatGPT

Download Skill