Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Jeniffen/projectr
Set up 📂-structure for data science projects
https://github.com/Jeniffen/projectr
data-science package r rstats setup
Last synced: 3 months ago
JSON representation
Set up 📂-structure for data science projects
- Host: GitHub
- URL: https://github.com/Jeniffen/projectr
- Owner: Jeniffen
- License: mit
- Created: 2020-04-24T15:43:29.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-15T03:19:00.000Z (almost 2 years ago)
- Last Synced: 2024-06-11T08:49:20.893Z (5 months ago)
- Topics: data-science, package, r, rstats, setup
- Language: R
- Homepage: https://jeniffen.github.io/projectr/
- Size: 219 KB
- Stars: 16
- Watchers: 0
- Forks: 2
- Open Issues: 15
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - Jeniffen/projectr - Set up 📂-structure for data science projects (R)
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# projectr 
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[](https://github.com/Jeniffen/projectr/releases/tag/v0.1.0)
[](https://github.com/Jeniffen/projectr/actions)
[](https://codecov.io/gh/Jeniffen/projectr?branch=master)
## Overview
The __projectr__ package is designed to be a lightweight package, with the
single goal of taking away the hassle of creating the _right_ folder structure
for any data science project. With the boilerplate being provided, any project
can be customized or enhanced to special needs and requirements.
The resulting folder structure is inspired by
[Coockiecutter Data Science](https://tinyurl.com/y89ay63o) and Edward Ma's
[blogpost](https://tinyurl.com/ybghtonj) on managing your data science project
early on. Further adjustments were made based on feedback by the data science
community.
## Installation
You can install the development version from GitHub with:
``` r
# install.packages("remotes")
remotes::install_github("Jeniffen/projectr")
```
## Usage
```r
projectr::set_me_up("my_project")
#> Your project has been successfully created!
#> Find below an outline of your structure:
#>
#> my_project # This is your project root
#> ¦
#> +-- data # Root folder for data
#> ¦ +-- 01_raw # Folder for all your raw data
#> ¦ +-- 02_intermediate # Folder for pre-processed data
#> ¦ +-- 03_processed # Folder for fully processed data
#> ¦ +-- 04_predictions # Folder to save predictions
#> ¦
#> +-- model # Folder to store all your models
#> ¦
#> +-- notebooks # Root folder for notebooks and Rmd files
#> ¦ +-- eda # Folder for exploratory data analysis
#> ¦ +-- misc # Folder to try things out or stuff
#> ¦
#> +-- references # Root folder for all explanatory files
#> ¦ +-- codebooks # Folder for codebooks of your datasets
#> ¦ +-- docs # Folder for general documentation
#> ¦ ¦ +-- figures # Folder to store figure and images
#> ¦ +-- reports # Folder to store visualizations and reports
#> ¦
#> +-- src # Root folder for all your scripts
#> +-- 01_preparation # Folder for setup and prep. scripts
#> +-- 02_processing # Folder for all kind of processing scripts
#> +-- 03_modelling # Folder for all your training scripts
#> +-- 04_visualization # Folder for all your visualisation scripts
#>
#> Good luck!
```
## Code of Conduct
Please note that the projectr project is released with a
[Contributor Code of Conduct](https://github.com/Jeniffen/projectr/wiki#contributor-code-of-conduct).
By contributing to this project, you agree to abide by its terms.