Implementing code review in the scientific workflow: Insights from ecology and evolutionary biology


Implementing code review in the scientific workflow: Insights from ecology and evolutionary biology

Ivimey-Cook, E. R.; Pick, J. L.; Bairos-Novak, K. R.; Culina, A.; Gould, E.; Grainger, M.; Marshall, B. M.; Moreau, D.; Paquet, M.; Royauté, R.; Sánchez-Tójar, A.; Simoes Silva, I. M.; Windecker, S. M.

Abstract

Code review increases reliability and improves reproducibility of research. As such, code review is an inevitable step in software development and is common in fields such as computer science. However, despite its importance, code review is noticeably lacking in ecology and evolutionary biology. This is problematic as it facilitates the propagation of coding errors and a reduction in reproducibility and reliability of published results. To address this, we provide a detailed commentary on how to effectively review code, how to set up your project to enable this form of review and detail its possible implementation at several stages throughout the research process. This guide serves as a primer for code review, and adoption of the principles and advice here will go a long way in promoting more open, reliable, and transparent ecology and evolutionary biology.

Keywords: ecology; evolutionary biology; open science; reliability; reproducibility; research process; software development; coding errors

Permalink: https://www.hzdr.de/publications/Publ-37635