Research Project Template

This repository contains a template folder structure for a research project.

.
├── README.md
├── analysis            <- all things data analysis
│   └── src             <- functions and other source files
├── comm
│   ├── internal_comm   <- internal communication such as meeting notes
│   └── journal_comm    <- communication with the journal, e.g. peer review
├── data
│   ├── data_clean      <- clean version of the data
│   └── data_raw        <- raw data (don't touch)
├── dissemination
│   ├── manuscripts
│   ├── posters
│   └── presentations
├── documentation       <- documentation, e.g. data management plan
└── misc                <- miscellaneous files that don't fit elsewhere

Please note that this is not the only possible way to structure a research project, but it might help you finding a good folder structure for yourself.

Using the template

1) Download

You can download this folder structure on GitHub via Code -> Download ZIP (see screenshot below) or by cloning the repository. Of course you can also fork this repository and by that create a new research project repository for yourself 😉.

2) Edit this README

The README should contain the information about your research project. For more information on writing good READMEs, please check out the README chapter of The Turing Way book.

3) Adjust to your needs

Add folders that you need and remove those that you don't need.

4) Add your files

Add your files to the folders.

🎉 That's all! Happy researching! 🎉