20.15 Repo setup
The base structure of a repository contains the following:
├── README.md <- Readme explaining the project.
├── Makefile <- Contains instructions to build the paper and/or run the analysis.
├── Dockerfile <- Contains instructions to build the virtual environment.
└── .gitignore <- Contains a list of files that are 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.