https://github.com/simrnsethi/cookie-cutter
A script to generate project skeleton for a new data analysis project.
https://github.com/simrnsethi/cookie-cutter
analysis cookiecutter data-science
Last synced: about 1 year ago
JSON representation
A script to generate project skeleton for a new data analysis project.
- Host: GitHub
- URL: https://github.com/simrnsethi/cookie-cutter
- Owner: simrnsethi
- Created: 2017-11-20T00:47:40.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-08T07:27:25.000Z (about 8 years ago)
- Last Synced: 2025-06-01T15:13:21.645Z (about 1 year ago)
- Topics: analysis, cookiecutter, data-science
- Language: Shell
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project Skeleton Development Script
The script below helps in creating a basic template for a data analysis project. It generates the folders and files
## Project Overview
A good workflow for a particular team depends on the tasks, goals,
and values of that team, whether they want to make their work
faster, more efficient, correct, compliant, agile, transparent, or
reproducible
### Data and Code Organization
The [`Cookie-Cutter`](cookie_cutter.sh) shell script creates a basic directory structure that might be useful for set-up a Data Science project
* The directories created using the shell script under are :
1. `CITATION` : For including any References or Citation docs for this project
2. `src` : source code files.
3. `data` : where all the data files may be stored
4. `doc`: For storing import docs, discussions or scripts for this project
5. `bin` : Model outputs and iterations
6. `results` : for storing the results of analysis or sample results from toolkit.
7. The License File for this project is included can be generated out of the 4 options: MIT, GNU, BSD - 3 Clause, Apache. A menu option lets you choose the License you want to include in the folder.
8. `requirements.txt`: To store information about all the requirements that might be re-create the analysis or to run a toolkit.
Steps to mirror this repo:
Clone this repo using the below code snippet in command-line:
```
git clone https://github.com/simrnsethi/cookie-cutter.git
```
### cookie_cutter shell script
Now that you have the cookie_cutter.sh file run the shell script.
(Make sure to clone this repo in your current directory)
```
bash cookie_cutter.sh
```
This will generate all the required folders.
## Author
Simran Sethi