Implementing Code Review in the Scientific Workflow: Insights from Ecology and Evolutionary Biology

This is a Preprint and has not been peer reviewed. The published version of this Preprint is available: https://doi.org/10.1111/jeb.14230. This is version 7 of this Preprint.

Add a Comment

You must log in to post a comment.


Comments

There are no comments or no comments have been made public for this article.

Downloads

Download Preprint

Supplementary Files
Authors

Edward Richard Ivimey-Cook, Joel L Pick, Kevin Bairos-Novak, Antica Culina, Elliot Gould , Matthew Grainger, Benjamin Marshall, David Moreau, Matthieu Paquet , Raphaël Royauté, Alfredo Sánchez-Tójar, Inês Silva , Saras Windecker

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.

DOI

https://doi.org/10.32942/X2CG64

Subjects

Life Sciences

Keywords

reliability, reproducibility, software development, coding errors, research process, open science, transparency, reproducibility, software development, coding errors, research process, open science, transparency

Dates

Published: 2023-05-16 18:08

Last Updated: 2023-10-11 23:41

Older Versions
License

CC-BY Attribution-No Derivatives 4.0 International

Additional Metadata

Language:
English

Conflict of interest statement:
None

Data and Code Availability Statement:
Not applicable