Repository setup

The base structure of a repository contains the following:

File or folder Description
README.md Readme explaining the project.
paper.md The paper in Markdown format.
references.bib The references in BibTeX format.
data/ Directory containing the data.
analysis/ Directory containing the code for the analyses.
figures/ Directory containing the figures.
Makefile Instructions on how to build the paper and/or run the analysis.
Dockerfile Instructions on how to build the virtual environment.
.gitignore A list of files excluded from git versioning.

The following templates are available for different use cases:

Use case Template
Paper repository Paper template
Analysis repository Analysis template
Literature review (and paper) CoLRev repository

The research team can decide to combine repositories (e.g., containing the paper with analyses) or create separate repositories.

Note
  • Add the tags research and paper to ensure that the repository is listed correctly in the overview.
  • Set the MY_PAT_TOKEN as a repository secret (for the Labot workflow)

TODO: describe creation of GitHub repository, see repositories (https://github.com/organizations/digital-work-lab/repositories/new)

Resources