Project Title

Project Status: [Planning / In pgrogess / Completed]

Project Description

• background
• aim of the project
• what does the code in this repo do?
• main methods
• links to any outputs, blogs.

Data source

Describe data sources, inlcluding links to public data or references to data sharing agreements.

How does it work?

What you need to do to reproduce the analysis or re-use the code on your local machine.

Requirements

Software or packages that needs to be installed and and how to install them.

For example: These scripts were written in R version (to be added) and RStudio Version 1.1.383. The following R packages (available on CRAN) are needed:

• tidyverse

Getting started

Describe the way in which the code can be used.

Useful references

Authors

• contributor name - [Twitter] - [GitHub]

License

This project is licensed under the [MIT License](link to license file).

Acknowledgments

• Credit anyone whose code was used
• Inspiration
• etc