ReproNim Reproducible Basics Module

Other day-to-day reproducible practices

Overview

Teaching: 25 min
Exercises: TODO min
Questions
  • How does reproducibility help in fixing bugs?

  • What can you do to be ready to share your studies reproducibly?

Objectives
  • Explain best practices on submitting bug reports


In this lesson, let’s cover some other relatively small aspects of reproducibility in basic day-to-day activities.

A good bug report is a reproducible one

“Reproducibility” is at the heart of what constitutes a good bug report.

References

Additional materials:

Overall summary:

Have reproducibility and openness in mind from the beginning

The devil is in the detail” and “Talk is cheap, show me the code” (L. Torvalds, Linux project) are two common idioms pointing to the fact that a verbal description alone, as typically condensed into a paper’s Methods section, is rarely sufficient to reproduce an empirical result.

That is why it is important to share also relevant data, code, description of the computation environments, etc. However, if you delay preparing your materials so they are ready to be shared, you might find it difficult, if not impossible, to actually be able to share your work later on as your project has progressed forward or may even be completed. Having the possibility of sharing in mind right from the beginning will make actual sharing a much easier task when you are actually ready or are asked to share.

References

Additional materials:

Key Points