03:00
Reproducible and FAIR Teaching Materials
Digital Research Academy Train the Trainer program
August 29, 2023
What is FAIR?
Findable
- Descriptive metadata and persistent identifier
Accessible
- Data could be openly available OR authentication and authorisation procedures are necessary
Interoperable
- Data needs to be integrated with other data and interoperate with applications or workflows
Reusable
- Documentation and license
Ten simple rules for making training materials FAIR
https://doi.org/10.1371/journal.pcbi.1007854
Illustration for paper “Ten simple rules for making training materials FAIR” (CC-BY 4.0)
What is Reproducibility?
“[…] when the same analysis steps performed on the same dataset […] produce the same answer.” (Turing Way)
FAIR and reproducible training materials are beneficial to you!
- Information sheets saves time in sharing information
- Clear communication (or you can update the information!)
- Saves time in on-boarding/re-using materials
- Preserved & Findable
- Easy to share within and outside your team
- Provides you and collaborators with credit (visibility, DOI, citations)
About Quarto
- Quarto is a new, open-source, scientific and technical publishing system
- Publish reproducible presentations, websites, blogs, and books in HTML, PDF, MS Word, ePub, etc.
- Consistent implementation of features across outputs: tabsets, code-folding, syntax highlighting, etc.
- Beginner-friendly with helpful guardrails for new learners, incl. YAML completion, informative syntax errors, etc.
- Multi-language support for R, Python, Julia, Observable and more functions via Jupyter
- Quarto extends RMarkdown and shares similarities with Juypter Notebooks.
- Support and community
Why we need version control …
… for code (text files) 
… for data (binary files) 
When everything is relevant …
… track everything.
What is version control?
“Version control is a systematic approach to record changes made in a […] set of files, over time. This allows you and your collaborators to track the history, see what changed, and recall specific versions later […]” (Turing Way)
keep track of changes in a directory (a “repository”)
take snapshots (“commits”) of your repo at any time
know the history: what was changed when by whom
compare commits and go back to any previous state
work on parallel “branches” & flexibly “merge” them
“push” your repo to a “remote” location & share it
share repos on platforms like GitHub or GitLab
work together on the same files at the same time
others can read, copy, edit and suggest changes
make your repo public and openly share your work
Create a DOI for your teaching materials with Zenodo
“Zenodo, a CERN service, is an open dependable home for the long-tail of science, enabling researchers to share and preserve any research outputs in any size, any format and from any science.” – from the Zenodo GitHub README
Integrate your teaching materials on GitHub with Zenodo
“To make your repositories easier to reference in academic literature, you can create persistent identifiers, also known as Digital Object Identifiers (DOIs). You can use the data archiving tool Zenodo to archive a repository on GitHub.com and issue a DOI for the archive.” – Details in the GitHub documentation
- Navigate to the login page for Zenodo.
- Click Log in with GitHub.
- Review the information about access permissions, then click Authorize zenodo.
- Navigate to the Zenodo GitHub page.
- To the right of the name of the repository you want to archive, toggle the button to On.
Thank you! 🙏
Images: Scriberia with The Turing Way community (License: CC BY 4.0)
💻 Slides: Slides are publicly available at lennartwittkuhn.com/dra-fair-teaching
📦 Software: Reproducible slides build with Quarto and deployed to GitHub Pages using GitHub Actions (details in the Quarto docs)
Source: Source code is available at github.com/lnnrtwttkhn/dra-fair-teaching
🖲️ DOI: 10.5281/zenodo.8296951 (generated using GitHub + Zenodo, see GitHub docs)
License: Creative Commons Attribution 4.0 International (CC BY 4.0)
💬 Contact: We welcome any feedback via email or GitHub issues. Thank you!