Reproducible Research Documentation

What problem does it solve?

This Skill provides standards and best practices for documenting R-based analyses, ensuring that research can be easily understood, verified, and reproduced by others.

Core Features & Use Cases

• Literate Programming: Guides the use of R Markdown and Quarto for integrated analysis reports.
• Project Documentation: Outlines essential elements for README files and R package descriptions.
• Code Commenting: Emphasizes explaining the 'why' behind code, not just the 'what'.
• Environment Management: Stresses the importance of sessionInfo(), renv, and seed logging.
• Use Case: When preparing an R analysis for publication or collaboration, use this Skill to ensure all documentation, from code comments to READMEs, adheres to best practices for reproducibility.

Quick Start

Use the documentation skill to create a README.md file for your R project that includes study objectives, software requirements, and reproduction instructions.