Skip to content

About

Template for repositories of the lifeobs team containing the scripts of a research article: folder structure, license, README and metadata files (Zenodo, citation).

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

14 Commits

Folders and files

Repository files navigation

Short title of the article

How to use this template (delete this block once the README is filled in)

  1. Click "Use this template" and name the repository year-lastname-topic.
  2. Replace everything in [brackets], and delete the folders you do not need.
  3. Check the license.
  4. Fill in .zenodo.example.json, then rename it to .zenodo.json (and delete the placeholders you do not need) before creating a release.
  5. Fill in CITATION.example.cff, then rename it to CITATION.cff.

Overview

One or two sentences on what these scripts do, with a link to the article: Full reference.

How to cite

[Zenodo DOI badge or reference once the release is archived.]

Repository organization

├── 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

Data

Where the data come from (repository, DOI, study name), how to access them, and any restrictions.

Requirements

Language and version (e.g. R 4.x), packages, and the file listing versions (renv.lock, requirements.txt, etc.).

How to reproduce the analyses

Order in which to run the scripts, expected outputs, approximate run time.

License

[GPL-3.0 or other], see LICENSE.

Authors and contact

Names, ORCID, and a contact email.

About

Template for repositories of the lifeobs team containing the scripts of a research article: folder structure, license, README and metadata files (Zenodo, citation).

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors