Resources

What is code review?

Code review is the process of methodically and systematically checking over code after it has been written.

Code review is popular among researchers at other institutions (see, e.g., Lisa DeBruine’s awesome code review guide from Glasgow), and we are excited to bring it to Edinburgh!

Code Review at PPLS Open Research

You can submit your codebase to our Open Research team for reviewing any of the following:

  1. Does it run?
    • Language-independent review
    • Receive feedback within 24 hours
  2. Is it reproducible?
    • Language-independent review
    • Receive feedback in 48-72 hours
  3. Is it auditable and understandable?
    • Language-dependent review
    • Receive feedback in 1 week
  4. Does it follow best practices?
    • Language-dependent review
    • Receive feedback in 1-2 weeks

For language-dependent review, our current team can help with projects using Python, R, PHP, MatLab, C++, Java, Javascript, TypeScript, Linux, Docker, Singularity, and HTML/CSS.

Please ensure that your review package includes:

     ✓ A README file that describes the project; specifies credit and licensing

     ✓ Any outputs that the reviewers should try to reproduce

     ✓ All data used to create the outputs to be reproduced

     ✓ All code necessary to recreate the outputs

     ✓ A main script that runs any subscripts in the relevant order

We look forward to hearing from you and helping you with your submissions!