{"id":32406414,"url":"https://github.com/kylegrealis/frogger","last_synced_at":"2025-10-25T12:53:26.587Z","repository":{"id":259267822,"uuid":"874902966","full_name":"kyleGrealis/froggeR","owner":"kyleGrealis","description":"Collection of workflow tools to get a \"jump\" on your projects","archived":false,"fork":false,"pushed_at":"2025-09-22T18:25:03.000Z","size":6538,"stargazers_count":32,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-22T20:32:07.992Z","etag":null,"topics":["data-science","project-management","quarto"],"latest_commit_sha":null,"homepage":"https://kylegrealis.com/froggeR/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kyleGrealis.png","metadata":{"files":{"readme":"README.md","changelog":"NEWS.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-10-18T17:11:57.000Z","updated_at":"2025-09-20T05:46:51.000Z","dependencies_parsed_at":"2024-10-24T01:30:51.677Z","dependency_job_id":"1be8cdeb-9b00-4eb0-a586-38e88063a3da","html_url":"https://github.com/kyleGrealis/froggeR","commit_stats":null,"previous_names":["kylegrealis/frogger"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/kyleGrealis/froggeR","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kyleGrealis%2FfroggeR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kyleGrealis%2FfroggeR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kyleGrealis%2FfroggeR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kyleGrealis%2FfroggeR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kyleGrealis","download_url":"https://codeload.github.com/kyleGrealis/froggeR/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kyleGrealis%2FfroggeR/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280958234,"owners_count":26420235,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-25T02:00:06.499Z","response_time":81,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["data-science","project-management","quarto"],"created_at":"2025-10-25T12:53:22.037Z","updated_at":"2025-10-25T12:53:26.582Z","avatar_url":"https://github.com/kyleGrealis.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"# froggeR \u003cimg src=\"man/figures/logo.png\" align=\"right\" height=\"130\"  alt=\"\" /\u003e\n\n\n[![R-CMD-check](https://img.shields.io/badge/R--CMD--check-passing-brightgreen)](https://github.com/kyleGrealis/froggeR)\n[![Lifecycle: maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html#maturing)\n[![CRAN status](https://www.r-pkg.org/badges/version/froggeR)](https://CRAN.R-project.org/package=froggeR)\n[![CRAN downloads](https://cranlogs.r-pkg.org/badges/grand-total/froggeR)](https://cran.r-project.org/package=froggeR)\n\n\u003e froggeR version: 0.5.2\n\nfroggeR is an R package designed to streamline the creation and management of Quarto projects. It provides a suite of tools to automate setup, ensure consistency, and enhance collaboration in data science workflows.\n\n## Why froggeR?\n\n\u003e Leap ahead in your data science journey with froggeR! Streamline Quarto workflows, create structured projects, and enhance collaboration with ease. 🐸\n\nfroggeR simplifies project setup so you can focus on what matters:\n\n* **Efficiency**: Minimize setup time, maximize analysis time\n* **Consistency**: Uniform styling and structure across all your projects\n* **Reliability**: Prevent common setup issues before they occur\n* **Security**: Robust `.gitignore` settings for enhanced data protection\n* **Collaboration**: Structured documentation for seamless team onboarding\n* **Customization**: Easy-to-use tools for tailoring project aesthetics\n* **Reproducibility**: Ensure consistent environments across team members\n\n----\n\n## Key Features\n\n* One-command Quarto project initialization\n* Centralized settings management for consistent metadata\n* Quickly create, save, and reuse metadata \u0026 Quarto branding\n* Automated creation of essential project files (README, .gitignore, etc.)\n* Custom YAML and SCSS templating for unique document styling\n* Interactive setup process for user-specific configurations\n\n----\n\n## Getting Started\n\nInstall froggeR and create your first project in minutes:\n\n```r\n# Install from CRAN... JUST APPROVED Jan. 15!\ninstall.packages(\"froggeR\")\n\n# Or get the development version\nremotes::install_github('kyleGrealis/froggeR')\n\n# Create your first froggeR project\nfroggeR::quarto_project('frogs')\n```\n----\n\n## Who's it for?\n\nfroggeR is ideal for R users who:\n\n* Manage multiple Quarto projects\n* Find themselves rewriting the same YAML \u0026 project structure repeatedly\n* Collaborate in team environments\n* Prioritize analysis over setup complexities\n* Need rapid project initialization\n\n----\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"man/figures/custom-yaml-rendered.png\" width=\"85%\" alt=\"Rendered Document Example\"\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\u003ci\u003eExample of a rendered Quarto document created with froggeR\u003c/i\u003e\u003c/p\u003e\n\n\n----\n\n### 🎯 Streamlined Quarto Project Creation\n\nInitialize a comprehensive Quarto project with a single command:\n\n```r\nfroggeR::quarto_project(name = 'my_new_project')\n```\n\nThis creates:\n\n* A Quarto document with custom YAML\n* A comprehensive `.gitignore`\n* Structured `README.md` \u0026 progress notes templates\n* Reusable `_variables.yml` \u0026 `_brand.yml` files\n* A `custom.scss` style sheet template\n* A `references.bib` for citations\n\n### 🔄 Centralized Settings Management\n\nMaintain consistent metadata across your documents:\n\n```r\nfroggeR::settings()\n```\n\nInteractively create or update metadata that is reusable across Quarto projects \u0026 \ndocuments with:\n\n* Author details\n* Contact information\n* Affiliations\n* Project metadata\n* Document preferences\n\n### 📝 Templated Quarto Documents\n\nQuickly generate new Quarto documents with pre-formatted headers:\n\n```r\nfroggeR::write_quarto(\n  filename = 'data_cleaning',\n  example = TRUE  # Add tool templates\n)\n```\n\n### 🛡️ Enhanced Git Protection\n\nSet up a comprehensive `.gitignore` for R projects:\n\n```r\nfroggeR::write_ignore()\n```\n\nAutomatically excludes:\n\n* R data files (`.RData`, `.rda`, `.rds`)\n* Common data formats (CSV, Excel, text files)\n* Sensitive information\n\n### 🌟 Custom Styling Made Easy\n\nGenerate a SCSS template for custom document styling:\n\n```r\nfroggeR::write_scss()\n```\n\nProvides a formatted stylesheet with:\n\n* SCSS defaults\n* SCSS mixins\n* SCSS rules\n\nCustomize your document's appearance by uncommenting desired styles.\n\n### 📚 Automated Project Documentation\n\nGenerate a structured README for your project:\n\n```r\nfroggeR::write_readme()\n```\n\nIncludes sections for:\n\n* Project overview\n* Setup instructions\n* File and directory explanations\n* Contribution guidelines\n\n----\n\n## Comparison with Other Tools\n\nWhile there are other project management tools for R, froggeR stands out by:\n\n* Focusing specifically on Quarto workflows\n* Providing a balance between automation and customization\n* Offering a comprehensive suite of tools in a single package\n* Emphasizing reproducibility and collaboration\n\n----\n\nWe're constantly improving froggeR. Upcoming features include:\n\n* Quarto dashboard integration\n* Integration with version control systems\n* Enhanced team collaboration tools\n* More customizable templates for various data science workflows\n\n----\n\n## Function Reference\n\n| Function | Description |\n|----------|-------------|\n| `settings()` | Manage persistent Quarto document metadata |\n|  `quarto_project()` | Initialize a complete Quarto project structure |\n| `write_quarto()`\\* | Create consistently formatted Quarto documents |\n| `write_variables()`\\* | Re-use metadata across projects \u0026 documents |\n| `save_variables()` | Save current `_variables.yml` to system-level configs |\n| `save_brand()` | Save current `_brand.yml` to system-level configs |\n| `write_brand()` | Create project-level `_brand.yml` configs |\n| `write_ignore()`\\* | Configure `.gitignore` for enhanced data security |\n| `write_readme()`\\* | Generate a comprehensive project README |\n| `write_notes()`\\* | Create a dated progress notes template |\n| `write_scss()`\\* | Create a customizable SCSS styling template |\n\\* *These functions are included with `quarto_project()`*\n\n----\n\n## Contributing\n\nWe're open to suggestions! If you have ideas for new features, please open an issue on our GitHub repository.\n\n----\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n\n---\n\nDeveloped by [Kyle Grealis](https://github.com/kyleGrealis)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkylegrealis%2Ffrogger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkylegrealis%2Ffrogger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkylegrealis%2Ffrogger/lists"}