Skip to content

Reusability check

Challenge: How reproducible and reusable is your project?

In this challenge you are going to check the reproducibility of each other’s repository.

  • Share the link to your GitHub project with one of your peers. Review the reproducibility of the project of one of your peers. Open a new GitHub issue in the project you are reviewing in which you answer these questions:

  • Is the code clearly documented and can you reproduce and reuse the code?

  • Are you able to rerun the analysis independently?
    • Note: in case of computationally intensive projects, it might be better to partially rerun the analysis (or with fewer repetitions or permutations if needed)
  • Which improvements do you suggest to make the code as clear as possible?

Further checks

If you want your project to be more thoroughly checked for (computational) reproducibility, you can consider submitting your data and code to Reprohack or CODECHECK. Even if you don’t, it would be helpful to take into account their guidelines: both initiatives emphasize that documentation of your code is key!

Looking at the repositories that have been CODECHECKed or the Reprohack reviews is another great way to get inspiration to improve the reusability of your own project.

Authorship day 2

This material was created by Eduard Klapwijk and Ole Mussman and is also disclosed via the Carpentries. The memes are added by Mees van Stiphout.