Does it provide CI/CD support for documentation?

Yes, the skill provides a complete GitHub Actions YAML configuration for automatically building and deploying pkgdown sites to GitHub Pages.

What is the roxygen2-pkgdown skill?

It is a specialized guide for R developers to help them document their code and build professional websites using roxygen2 and pkgdown within the Claude Code environment.

Is markdown supported in the documentation?

Absolutely, the skill covers how to enable markdown support in your DESCRIPTION file and use standard markdown syntax within your roxygen2 blocks.

How do I link to functions in other R packages?

The skill provides specific syntax patterns for cross-referencing functions from external packages like dplyr, stats, or ggplot2 using standard markdown or RD links.

Can this skill handle S4 classes and methods?

Yes, it includes specific patterns for documenting S4 classes, slots, and methods alongside standard S3 methods and functions.

Roxygen2 & Pkgdown Documentation

Name: Roxygen2 & Pkgdown Documentation
Author: choxos

bychoxos

0•

Learning & Documentation

Automates and optimizes R package documentation and website creation using roxygen2 tags and pkgdown configurations.

This skill provides a comprehensive guide and implementation patterns for documenting R packages, bridging the gap between source code comments and professional documentation. It offers precise syntax for roxygen2 tags, S3/S4 method exports, cross-referencing, and sophisticated pkgdown site customization. It is an essential resource for R developers aiming to create CRAN-compliant packages with high-quality, searchable, and visually appealing web-based documentation, complete with automated GitHub Actions deployment workflows.

Key Features

01Cross-referencing between internal functions and external package documentation

02Advanced S3/S4 method documentation and inheritance patterns

03Standardized roxygen2 tag implementation for functions, parameters, and return values

04Comprehensive pkgdown site configuration and visual styling

05Automated GitHub Actions workflow for documentation deployment

060 GitHub stars

Use Cases

01Automating the documentation build and deployment process via CI/CD

02Building and customizing a professional documentation website for an R package

03Creating CRAN-compliant documentation for complex R functions and classes

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