research-project-template

KO | EN

gitlite — search

#javascript #python #react #ai #typescript #llm #golang #android #linux #macos #kubernetes #awesome-list #security #open-source

research-project-template

(★ 24)

Template folder structure for a research project

research-project-template Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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 :wink:.
<img width="933" alt="Screenshot 2022-12-02 at 15 04 35" src="https://user-images.githubusercontent.com/14146757/205311114-badd0aca-b862-46f0-af34-52a389a89fd9.png">

### 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](https://the-turing-way.netlify.app/project-design/project-repo/project-repo-readme.html?highlight=readme) 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.

:tada: That's all! Happy researching! :tada:

## Further reading
Interested in more like this? Check out my newsletter post on [FAIR and reproducible projects](https://heidiseibold.ck.page/posts/setting-up-a-fair-and-reproducible-project).

research-project-template

research-project-template Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

research-project-template

research-project-template Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README