This is an example template to help format a research project from start to finish.
Reproducible research is crucial to the scientific enterprise, but the field of animal behavior has been slow to adopt best practices:
Miller, S.E., Jernigan, C.M., Legan, A.W., Miller, C.H., Tumulty, J.P., Walton, A. and Sheehan, M.J., 2021. Animal behavior missing from data archives. Trends in Ecology & Evolution. doi: 10.1016/j.tree.2021.07.008
But we can do better! There are some great resources available for increasing reproducibility, and this template should help provide lab-specific information for organizing your project. For more general information, see:
A Guide to Reproducible Code in Ecology and Evolution, British Ecological Society, 2017
This is a template repository, which means you can create a new repository with the same directory structure and files as this exisiting repository. It's similar to creating a fork, but the repository histories will be unrelated.
To use this template, simply click Use this Template, select your account, and name your repository the same way you would when creating a new one.
There are eight folders by default, four of which will typically become part of your final public repository upon publication, and four which can remain private or local to you. You can change which folders and files and tracked with a .gitignore file.
Each folder contains a readme with specific instructions. Recommended order is as follows:
- RawData (private)
- DataCurationCode (private)
- SharedData (public)
- AnalysisCode (public)
- IntermediateData (public)
- TablesFigures (public)
- References (private)
- Drafts (private)
Pull requests are welcome. For major changes, open an issue or email me directly vjf5@georgetown.edu