froggeR
froggeR: Structured project standards for R and Quarto
Most programming languages have conventions for where files belong. R rarely agrees on one, and it shows. Scripts, Quarto documents, stylesheets, and data files pile up in root directories like laundry on a chair. froggeR offers a standard: R/ for scripts, pages/ for Quarto documents, data/ for data files, www/ for assets. Build habits that carry over whether you're writing an analysis, building an R package, or picking up a new language entirely.
Table of Contents
- Why froggeR?
- Installation
- Project Creation
- Configuration & Reusability
- Templated Quarto Documents
- Git Protection
- Custom Styling
- Function Reference
- Getting Help
- Contributing
- License
Why froggeR?
froggeR gives every project the same enforced layout so you spend time analyzing, not organizing:
- Structure by default:
init()downloads the latest scaffold and you're working in seconds. Scripts go inR/, Quarto documents inpages/, assets inwww/, data indata/. Every project, every time. - Opinionated starting points:
R/_load.R,R/_libraries.R, andR/_data_dictionary.Rgive every project a consistent entry point.write_quarto()creates pre-formatted.qmdfiles with your author info and branding baked in. - Configure once, reuse everywhere:
write_variables()andwrite_brand()create your metadata and branding files. Save globally withsave_variables()andsave_brand(), and every future project picks them up automatically. - Protected by default: An opinionated
.gitignoreand pre-commit hooks keep sensitive data and common R artifacts out of version control. - Transferable habits: The same directory conventions used here mirror what you'll find in R packages, Shiny frameworks like golem and rhino, and other languages entirely. Good habits compound.
Installation
install.packages("froggeR")