How to use this template (delete this block once the README is filled in)
- Click "Use this template" and name the repository
year-lastname-topic.- Replace everything in [brackets], and delete the folders you do not need.
- Check the license.
- Fill in
.zenodo.example.json, then rename it to.zenodo.json(and delete the placeholders you do not need) before creating a release.- Fill in
CITATION.example.cff, then rename it toCITATION.cff.
One or two sentences on what these scripts do, with a link to the article: Full reference.
[Zenodo DOI badge or reference once the release is archived.]
├── README.md
├── LICENSE
├── .zenodo.json
├── CITATION.cff
├── .gitignore
├── data/ # input data (or how to get data from a remote repository)
├── scripts/ # analysis scripts, numbered (01_..., 02_...)
├── functions/ # functions used by the scripts (optional)
├── outputs/ # generated outputs (tables, models) (optional)
└── figures/ # generated figures
Where the data come from (repository, DOI, study name), how to access them, and any restrictions.
Language and version (e.g. R 4.x), packages, and the file listing versions (renv.lock, requirements.txt, etc.).
Order in which to run the scripts, expected outputs, approximate run time.
[GPL-3.0 or other], see LICENSE.
Names, ORCID, and a contact email.