Reproducible Research for Beginners

Build a small research project that a colleague can rerun. Use sample data to organize files, track analysis code with Git, record a Python environment and assemble a reproducibility package.

LanguageEnglish

What you’ll build

  1. A documented dataset
  2. Versioned analysis code
  3. A handoff someone else can run
Start the tutorial

Chapters

The first two chapters need no coding experience. For the hands-on chapters, you’ll use a terminal, Git and Python 3.

  1. What Is Reproducible Research?Learn what makes research computationally reproducible and how reproducibility, replicability and robustness differ in one worked example. 5 min read
  2. How to Organize Research DataSet up a research project folder structure and download a README and data dictionary template with worked examples. 6 min read
  3. How to Use Git for Research CodeUse Git to track research code and record the exact commit that produced a paper’s table or figure. 7 min read
  4. How to Document a Python Environment for Reproducible ResearchRecord Python, system and dependency versions, the analysis command and the expected output. Includes a worked environment record. 7 min read
  5. How to Create a Research Reproducibility PackageUse a checklist for a paper’s reproducibility package and download a complete data, code, README and expected output example. 6 min read