emmachollet / goodcodingpractice

TITLE

This repository contains scripts to download, process, and analyze data for XXX.

Authors: XXX

Correspondence: [email protected] or Name Surname

Date: XX.XX.XXXX

Overview

What is the project about? What is the output used for?

Data

Where does the input data come from? Who provided the data (name, correspondence)? Describe the data.

Folders and files

Is there a main script? Where do we set the working directory? Which scripts should we run in which order?

Overarching folder/scripts folder

filename	description
README.md	Text file (markdown format) description of the project.

Input files

Directory: name_of_the_folder

filename	description
input_1.csv	blablabla.
input_2.dat	blablabla.

Output files

Directory: name_of_the_folder

filename	description
output_1.csv	blablabla.
outut_2.dat	blablabla.

Plots

Directory: name_of_the_folder

filename	description
plots_1.pdf	blablabla.
plots_2.png	blablabla.

Intermediate results

Directory: name_of_the_folder

Project diagram/figure

Authors contribution

XXX initiated the study and acquired funding. XXX, XXX and XXX designed the study. XXX and XXX implemented the models and carried out the simulations and visualization of the results. All authors contributed to the analysis of the results. XXX wrote the first draft of the paper and all authors contributed to writing and revisions.

Acknowledgements:

---

Markdown specificities

italic bold italic and bold script

Use backlash to escape characters: * - etc

1. bullet point 1
2. bullet point 2
3. bullet point 3

• list
• list:
  • sublist
  • sublist
• list

Block quote. Block quote.

Nested block quote.

Block quote.

hyperlink website or https://github.com/emmachollet

Table of Contents:

1. Example
2. Example2
3. Third Example
4. Fourth Example

Example

Example2

Third Example

Fourth Example