{"id":14068279,"url":"https://github.com/Jeniffen/projectr","last_synced_at":"2025-07-30T03:32:45.052Z","repository":{"id":47803866,"uuid":"258554697","full_name":"Jeniffen/projectr","owner":"Jeniffen","description":"Set up 📂-structure for data science projects","archived":false,"fork":false,"pushed_at":"2022-11-15T03:19:00.000Z","size":224,"stargazers_count":16,"open_issues_count":15,"forks_count":2,"subscribers_count":0,"default_branch":"main","last_synced_at":"2024-12-04T09:39:08.833Z","etag":null,"topics":["data-science","package","r","rstats","setup"],"latest_commit_sha":null,"homepage":"https://jeniffen.github.io/projectr/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Jeniffen.png","metadata":{"files":{"readme":"README.Rmd","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-04-24T15:43:29.000Z","updated_at":"2022-11-20T03:32:11.000Z","dependencies_parsed_at":"2023-01-23T04:01:19.811Z","dependency_job_id":null,"html_url":"https://github.com/Jeniffen/projectr","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/Jeniffen/projectr","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jeniffen%2Fprojectr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jeniffen%2Fprojectr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jeniffen%2Fprojectr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jeniffen%2Fprojectr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Jeniffen","download_url":"https://codeload.github.com/Jeniffen/projectr/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jeniffen%2Fprojectr/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267803984,"owners_count":24146527,"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-07-30T02:00:09.044Z","response_time":70,"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","package","r","rstats","setup"],"created_at":"2024-08-13T07:06:04.237Z","updated_at":"2025-07-30T03:32:44.651Z","avatar_url":"https://github.com/Jeniffen.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\",\n  out.width = \"100%\"\n)\n```\n\n# projectr \u003ca href='#'\u003e\u003cimg src='man/figures/logo.png' align=\"right\" height=\"138.5\" /\u003e\u003c/a\u003e\n\n\u003c!-- badges: start --\u003e\n[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange)](https://lifecycle.r-lib.org/articles/stages.html#experimental)\n[![version](https://img.shields.io/badge/version-0.1.0-green%22)](https://github.com/Jeniffen/projectr/releases/tag/v0.1.0)\n[![R build status](https://github.com/Jeniffen/projectr/workflows/R-CMD-check/badge.svg)](https://github.com/Jeniffen/projectr/actions)\n[![Codecov test coverage](https://codecov.io/gh/Jeniffen/projectr/branch/master/graph/badge.svg)](https://codecov.io/gh/Jeniffen/projectr?branch=master)\n\u003c!-- badges: end --\u003e\n\n## Overview \n\nThe __projectr__ package is designed to be a lightweight package, with the \nsingle goal of taking away the hassle of creating the _right_ folder structure \nfor any data science project. With the boilerplate being provided, any project \ncan be customized or enhanced to special needs and requirements. \n\nThe resulting folder structure is inspired by \n[Coockiecutter Data Science](https://tinyurl.com/y89ay63o) and Edward Ma's \n[blogpost](https://tinyurl.com/ybghtonj) on managing your data science project \nearly on. Further adjustments were made based on feedback by the data science \ncommunity. \n\n\n## Installation\n\nYou can install the development version from GitHub with:\n\n``` r\n# install.packages(\"remotes\")\nremotes::install_github(\"Jeniffen/projectr\")\n```\n## Usage \n\n```r\nprojectr::set_me_up(\"my_project\")\n#\u003e Your project has been successfully created!\n#\u003e Find below an outline of your structure:\n#\u003e \n#\u003e my_project                   # This is your project root                 \n#\u003e ¦                                                                        \n#\u003e +-- data                     # Root folder for data                      \n#\u003e ¦   +-- 01_raw               # Folder for all your raw data              \n#\u003e ¦   +-- 02_intermediate      # Folder for pre-processed data             \n#\u003e ¦   +-- 03_processed         # Folder for fully processed data           \n#\u003e ¦   +-- 04_predictions       # Folder to save predictions                \n#\u003e ¦                                                                        \n#\u003e +-- model                    # Folder to store all your models           \n#\u003e ¦                                                                        \n#\u003e +-- notebooks                # Root folder for notebooks and Rmd files   \n#\u003e ¦   +-- eda                  # Folder for exploratory data analysis      \n#\u003e ¦   +-- misc                 # Folder to try things out or stuff         \n#\u003e ¦                                                                        \n#\u003e +-- references               # Root folder for all explanatory files     \n#\u003e ¦   +-- codebooks            # Folder for codebooks of your datasets     \n#\u003e ¦   +-- docs                 # Folder for general documentation          \n#\u003e ¦   ¦   +-- figures          # Folder to store figure and images         \n#\u003e ¦   +-- reports              # Folder to store visualizations and reports\n#\u003e ¦                                                                        \n#\u003e +-- src                      # Root folder for all your scripts          \n#\u003e     +-- 01_preparation       # Folder for setup and prep. scripts        \n#\u003e     +-- 02_processing        # Folder for all kind of processing scripts \n#\u003e     +-- 03_modelling         # Folder for all your training scripts      \n#\u003e     +-- 04_visualization     # Folder for all your visualisation scripts \n#\u003e \n#\u003e Good luck!\n```\n## Code of Conduct\n\nPlease note that the projectr project is released with a \n[Contributor Code of Conduct](https://github.com/Jeniffen/projectr/wiki#contributor-code-of-conduct). \nBy contributing to this project, you agree to abide by its terms.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJeniffen%2Fprojectr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FJeniffen%2Fprojectr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJeniffen%2Fprojectr/lists"}