r-documentation-patternslisted

# R Documentation Patterns ## Overview Best practices and patterns for documenting R code, packages, and projects. Covers README files, code comments, function documentation, and project-level documentation. ## README Documentation ### README Structure ```markdown # Package Name <!-- badges: start --> [](https://github.com/user/pkg/actions/workflows/R-CMD-check.yaml) [](https://CRAN.R-project.org/package=pkg) [](https://lifecycle.r-lib.org/articles/stages.html#stable) [](https://app.codecov.io/gh/user/pkg?branch=main) <!-- badges: end --> ## Overview Brief description of what the package does (2-3 sentences). ## Installation ```r # From CRAN install.packages("pkg") # Development version from GitHub # install.packages("pak") pak::pak("user/pkg") ``` ## Usage ```r library(pkg) # Basic example result <- main_function(data) ``` ## Getting Help - [Package documentation](https://user.github.io/pkg/) - [Report bugs](https://github.com/user/pkg/issues) ## License MIT © [Author Name](https://github.com/user) ``` ### Badges ```r # Common badges usethis::use_badge("CRAN status") usethis::use_lifecycle_badge("stable") usethis::use_github_actions_badge("R-CMD-chec