Implementing code review in the scientific workflow: Insights from ecology and evolutionary biology
Journal of Evolutionary Biology · 01.10.2023 · 36 (10) · 1347-1356
DOI: 10.1111/jeb.14230 ↗Kurz gefasst
Fachartikel in der Zeitschrift Journal of Evolutionary Biology, online erschienen am 01.10.2023. Verfasst von Edward R Ivimey-Cook und 12 weiteren Autor:innen. Beteiligte Einrichtung: School of Biodiversity, One Health and Veterinary Medicine, University of Glasgow, Glasgow, UK. Hauptthemen laut MEDLINE: Biological Evolution, Ecology. Die Arbeit wurde bisher 32-mal zitiert (Crossref) und nennt 67 Literaturangaben. Der Volltext ist frei zugänglich (Open Access, CC BY 4.0). Gefördert von: Center of Advanced Systems Understanding.
Abstract (Originalsprache)
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. Abstract Code review is the process of either informally (as part of a group, as colleagues) or formally (as part of the peer review process) checking and evaluating each other's code and is a critical method of reducing errors and increasing research reproducibility and reliability. In this paper, we provide a detailed commentary on how to effectively review code (including introducing the four Rs), how to set up your project to enable this form of review and detail its possibleimplementation at several stages throughout the research process.
Schlagwörter
MeSH-Schlagwörter (MEDLINE)
Stichwörter der Autor:innen
Autor:innen und Institutionen
- School of Biodiversity, One Health and Veterinary Medicine, University of Glasgow, Glasgow, UK.
- Institute of Ecology and Evolution, University of Edinburgh, Edinburgh, UK.
- Australian Research Council Centre of Excellence for Coral Reef Studies & College of Science and Engineering, James Cook University, Townsville, Queensland, Australia.
- Rudjer Boskovic Institute, Zagreb, Croatia.
- Netherlands Institute of Ecology, NIOO-KNAW, Wageningen, the Netherlands.
- School of Ecosystem and Forest Sciences, University of Melbourne, Melbourne, Victoria, Australia.
ORCID-Profile: Edward R Ivimey-Cook, Joel L Pick, Kevin R Bairos-Novak, Antica Culina, Elliot Gould, Matthew Grainger, Benjamin M Marshall, David Moreau, Matthieu Paquet, Raphaël Royauté, Alfredo Sánchez-Tójar, Inês Silva, Saras M Windecker
Förderung
- Center of Advanced Systems Understanding
Zitieren
APA
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., Silva, I., & Windecker, S. M. (2023). Implementing code review in the scientific workflow: Insights from ecology and evolutionary biology. Journal of Evolutionary Biology, 36(10), 1347-1356. https://doi.org/10.1111/jeb.14230
Vancouver
Ivimey-Cook ER, Pick JL, Bairos-Novak KR, Culina A, Gould E, Grainger M, et al. Implementing code review in the scientific workflow: Insights from ecology and evolutionary biology. Journal of Evolutionary Biology. 2023;36(10):1347-1356. doi:10.1111/jeb.14230
BibTeX
@article{IvimeyCook2023,
author = {Ivimey-Cook, Edward R and Pick, Joel L and Bairos-Novak, Kevin R and Culina, Antica and Gould, Elliot and Grainger, Matthew and Marshall, Benjamin M and Moreau, David and Paquet, Matthieu and Royauté, Raphaël and Sánchez-Tójar, Alfredo and Silva, Inês and Windecker, Saras M},
title = {Implementing code review in the scientific workflow: Insights from ecology and evolutionary biology},
journal = {Journal of Evolutionary Biology},
year = {2023},
volume = {36},
number = {10},
pages = {1347--1356},
doi = {10.1111/jeb.14230}
}
EUVIMED