Can I use this to generate a README for my R package?

Absolutely. The skill includes a standardized structure for R package READMEs, including installation instructions, usage examples, and automated status badges.

Does it support documenting datasets within an R package?

Yes, it includes specific patterns for documenting example datasets, including format descriptions, source citations, and usage examples.

Does this skill support roxygen2 for R documentation?

Yes, it provides specific templates and best practices for using roxygen2 to document functions, datasets, and package-level metadata efficiently.

How does this skill help with CRAN submissions?

It follows standard R community conventions for DESCRIPTION files, namespace exports, and documentation structures, which are critical for passing automated CRAN checks.

Can I create architectural diagrams for my R projects?

Yes, the skill provides patterns for using Mermaid diagrams within your documentation to visualize package flow and component relationships.

Professional R Documentation Patterns

Name: Professional R Documentation Patterns
Author: choxos

bychoxos

0•

学習とドキュメンテーション

Standardizes the creation of high-quality, CRAN-compliant documentation for R packages and biostatistical projects.

This skill provides a comprehensive suite of best practices and templates for documenting R code, packages, and research projects. It streamlines the creation of professional README files with dynamic badges, detailed function documentation using roxygen2, and structured vignettes for user guides. Whether you are preparing a package for CRAN submission or documenting complex data science workflows, this skill ensures your R projects are reproducible, maintainable, and adhere to the rigorous standards of the R ecosystem.

主な機能

01Standardized README templates with automated status badges

02Package-level metadata and DESCRIPTION file optimization

03Structured vignette and dataset documentation guidelines

04Comprehensive roxygen2 function documentation patterns

05Integration of Mermaid diagrams for package architecture documentation

060 GitHub stars

ユースケース

01Establishing consistent documentation standards across data science teams

02Preparing R packages for official submission to CRAN or Bioconductor

03Documenting complex biostatistical analysis pipelines for clinical research

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add choxos/biostatagent r-documentation-patterns

For use in Claude.ai and ChatGPT

主な機能

01Standardized README templates with automated status badges

02Package-level metadata and DESCRIPTION file optimization

03Structured vignette and dataset documentation guidelines

04Comprehensive roxygen2 function documentation patterns

05Integration of Mermaid diagrams for package architecture documentation

060 GitHub stars

ユースケース

01Establishing consistent documentation standards across data science teams

02Preparing R packages for official submission to CRAN or Bioconductor

03Documenting complex biostatistical analysis pipelines for clinical research

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add choxos/biostatagent r-documentation-patterns

For use in Claude.ai and ChatGPT