Can it generate documentation for R datasets?

Absolutely, it includes specific patterns for documenting data frames, including format descriptions, column definitions, and usage examples for internal or exported data.

Is it compatible with Tidyverse style guides?

Yes, the patterns are aligned with modern R development standards, utilizing tools like devtools, usethis, and pkgdown for a consistent look and feel.

Does this skill help with CRAN submissions?

Yes, it follows standard R package development patterns including DESCRIPTION file requirements and roxygen2 tags necessary for generating CRAN-compliant documentation.

How does it handle complex statistical functions?

It provides advanced templates that include sections for model assumptions, specific return value descriptions (S3 classes), and cross-references to related statistical functions.

Does it support visual architecture documentation?

Yes, it includes guidelines for using Mermaid diagrams within R documentation to visualize data flow, package logic, and component interactions.

R Documentation Patterns

Name: R Documentation Patterns
Author: choxos

bychoxos

0•

Learning & Documentation

Standardizes R package and project documentation using professional roxygen2 templates, README structures, and vignette patterns.

This skill equips Claude with expert knowledge for documenting R code according to industry standards used by the Tidyverse and CRAN. It provides structured templates for function-level documentation using roxygen2, comprehensive README layouts with automated badges, and detailed guidance for DESCRIPTION files and vignettes. By implementing these patterns, users can ensure their R projects are maintainable, user-friendly, and ready for professional distribution, covering everything from simple utility scripts to complex statistical packages and architectural diagrams.

Key Features

01Best practices for code commenting and architecture visualization via Mermaid

02Structured vignette templates for tutorials and technical deep-dives

030 GitHub stars

04Professional README structures with dynamic badges and installation guides

05Standardized roxygen2 templates for simple and complex R functions

06Comprehensive package-level documentation including DESCRIPTION file patterns

Use Cases

01Generating high-quality technical guides and vignettes for R-based tools

02Preparing an R package for submission to CRAN or Bioconductor

03Standardizing documentation across a team's internal data science projects

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add choxos/tidyrmodelling r-documentation-patterns

For use in Claude.ai and ChatGPT

Download Skill