Best Practices in Writing Reproducible Code
1
Welcome!
2
Acknowledgements
3
Preparation
3.1
Data and/or Code
3.2
Terminal
3.3
Git
3.3.1
Coding Platforms
3.3.2
Install Git
3.3.3
git config
3.3.4
Set up SSH keys
3.3.5
If SSH fails, HTTPS!
3.4
Final Test!
4
Introduction
4.1
Schedule
4.1.1
Pre-Workshop Installation Support
4.1.2
Day 1
4.1.3
Day 2
4.2
Course Materials
4.2.1
Slides
4.2.2
Exercises
5
Project Management
5.1
Project setup
5.1.1
Video
5.1.2
Slides
5.1.3
Exercises
5.2
Version control
5.2.1
Video
5.2.2
Slides
5.2.3
Exercise
5.3
Publication & licensing
5.3.1
Video
5.3.2
Slides
5.3.3
Exercise
6
Code Quality
6.1
Readability
6.1.1
Video
6.1.2
Slides
6.1.3
Exercise
6.2
Reusability
6.2.1
Video
6.2.2
Slides
6.2.3
Exercise
6.3
Robustness
6.3.1
Video
6.3.2
Slides
6.3.3
Exercise
7
Documentation
7.1
Comments and docstrings
7.1.1
Video
7.1.2
Slides
7.1.3
Exercise
7.2
The README page
7.2.1
Video
7.2.2
Slides
7.2.3
Exercise
8
Accessibility & Reproducibility
8.1
Dependencies
8.1.1
Video
8.1.2
Slides
8.1.3
Exercise
8.2
Binder
8.2.1
Video
8.2.2
Exercise (optional)
8.3
Archiving
8.3.1
Video
8.3.2
Slides
8.3.3
Exercise (optional)
9
References
Published with bookdown
Best Practices in Writing Reproducible Code
8.3
Archiving
8.3.1
Video
8.3.2
Slides
Slides
8.3.3
Exercise (optional)
Follow the workflow
outlined in this guide
to archive your code to Zenodo. Use the
Sandbox version of Zenodo
to make sure your repository is not actually archived permanently!