Can I document S4 classes with this skill?

Absolutely, it provides specific tags for documenting S4 slots, methods, and class exports effectively.

Can I share documentation between multiple functions?

Yes, it demonstrates the use of @rdname and @inheritParams to consolidate documentation for related functions into a single help file.

How do I automate the documentation site build?

The skill includes a pre-configured GitHub Actions workflow YAML that handles dependency installation, site building, and deployment to GitHub Pages.

Does this support Markdown in R documentation?

Yes, it includes instructions for enabling Markdown support in your DESCRIPTION file and using standard Markdown syntax within roxygen2 comments.

How do I organize the pkgdown navigation bar?

It covers _pkgdown.yml configuration for customizing the navbar structure, including links to articles, references, and external repositories like GitHub.

R Package Documentation & pkgdown

Name: R Package Documentation & pkgdown
Author: choxos

bychoxos

0•

学习与文档

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

This skill serves as a complete guide for R developers to create high-quality package documentation and professional websites. It provides a full reference for roxygen2 tags, including parameter documentation, return values, and examples, while also covering advanced topics like S3/S4 methods and cross-referencing. Users can leverage this skill to configure pkgdown for custom branding, organize reference indexes, and set up automated deployment pipelines via GitHub Actions, ensuring that their R packages are well-documented and easily accessible.

主要功能

01Advanced pkgdown configuration for custom documentation sites

020 GitHub stars

03Complete roxygen2 tag reference for functions and datasets

04Cross-referencing syntax for internal and external R packages

05Inheritance patterns for S3 methods and S4 classes

06Automated GitHub Actions templates for site deployment

使用场景

01Preparing R packages for CRAN or Bioconductor submission

02Implementing automated documentation workflows in CI/CD pipelines

03Generating searchable documentation websites for internal R tools

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add choxos/biostatagent roxygen2-pkgdown

For use in Claude.ai and ChatGPT

主要功能

01Advanced pkgdown configuration for custom documentation sites

020 GitHub stars

03Complete roxygen2 tag reference for functions and datasets

04Cross-referencing syntax for internal and external R packages

05Inheritance patterns for S3 methods and S4 classes

06Automated GitHub Actions templates for site deployment

使用场景

01Preparing R packages for CRAN or Bioconductor submission

02Implementing automated documentation workflows in CI/CD pipelines

03Generating searchable documentation websites for internal R tools

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add choxos/biostatagent roxygen2-pkgdown

For use in Claude.ai and ChatGPT