2023
DOI: 10.1111/jeb.14230
|View full text |Cite
|
Sign up to set email alerts
|

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

Edward R. Ivimey-Cook,
Joel L. Pick,
Kevin R. Bairos-Novak
et al.

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 re… Show more

Help me understand this report

Search citation statements

Order By: Relevance

Paper Sections

Select...
1
1
1

Citation Types

0
3
0

Year Published

2023
2023
2024
2024

Publication Types

Select...
6
1

Relationship

0
7

Authors

Journals

citations
Cited by 11 publications
(3 citation statements)
references
References 51 publications
0
3
0
Order By: Relevance
“…While widespread availability of code would undoubtedly assist audit studies investigating computational reproducibility post-publication, the success rate of such studies would be further improved (perhaps substantially so) if code was reviewed before publication, perhaps as part of peer review as discussed by Fernández-Juricic [ 67 ]. Ivimey-Cook et al [ 68 ] provide a comprehensive primer of code review at all stages of a research project, outlining a workflow for conducting effective reviews. Implementing code review into the research process (whether as part of formal peer review or not) would require a change in current research practices and the allocation of resources; the costs of this would need to be compared against the advantages of enhancing the reproducibility of reported results.…”
Section: Discussionmentioning
confidence: 99%
“…While widespread availability of code would undoubtedly assist audit studies investigating computational reproducibility post-publication, the success rate of such studies would be further improved (perhaps substantially so) if code was reviewed before publication, perhaps as part of peer review as discussed by Fernández-Juricic [ 67 ]. Ivimey-Cook et al [ 68 ] provide a comprehensive primer of code review at all stages of a research project, outlining a workflow for conducting effective reviews. Implementing code review into the research process (whether as part of formal peer review or not) would require a change in current research practices and the allocation of resources; the costs of this would need to be compared against the advantages of enhancing the reproducibility of reported results.…”
Section: Discussionmentioning
confidence: 99%
“…In line with our philosophy that simply uploading code to a repository is only the first step towards replicable methods, the MIROSLAV analysis code is predominantly written in the form of notebooks [45][46][47][48] -documents with human-readable, formatted text serving as documentation, with interspersed code cells where configuration parameters can be modified and code can be executed to produce the desired results within the document itself. With this approach, users of all programming skill levels can quickly become intimately familiar with how their data is handled throughout the entire process.…”
Section: Mirosinementioning
confidence: 99%
“…There are a series of good practices in biodiversity data management that should be followed in similar studies but evaluating other taxa or regions. First, it is important to document the use of scripts and publish the code (either in R or in other languages) in open repositories such as GitHub, to make the whole process comparable and reproducible (Ivimey‐Cook et al., 2023 ). Second, researchers should review the most recent packages and web services to manage occurrence records and use the most updated source of taxonomy available (Grenié et al., 2022 ).…”
Section: Main Conclusionmentioning
confidence: 99%