Skip to content

Commit 4634d5d

Browse files
chrstngynchrstngyn
chrstngyn
authored and
chrstngyn
committed
refactor: reproducibility -> reusability
related to #128
1 parent cd7295e commit 4634d5d

File tree

3 files changed

+22
-22
lines changed

3 files changed

+22
-22
lines changed

.github/ISSUE_TEMPLATE/reproducibility.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
name: Reproducibility
3-
about: Use this template for reproducibility standards
2+
name: Reusability
3+
about: Use this template for reusability standards
44
title: ''
55
labels: standards - reusability
66
assignees: alee

content/en/standards/reproducibility/_index.md renamed to content/en/standards/reuasbility/_index.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
---
2-
title: Reproducibility
3-
linkTitle: Reproducibility
2+
title: Reusability
3+
linkTitle: Reusability
44
cascade:
5-
type: reproducibility
6-
github_issue_filter: "label:\"standards - reproducibility\""
7-
github_issue_template: reproducibility.md
5+
type: reusability
6+
github_issue_filter: "label:\"standards - reusability\""
7+
github_issue_template: reusability.md
88
weight: 2
99
---
1010

1111
{{% standards-preamble %}}
12-
These standards promote the reuse of model code and reproducibility of model results.
12+
These standards promote the reuse of model code and reusability of model results.
1313
{{% /standards-preamble %}}
1414

15-
## Overview of Reproducibility Standards
15+
## Overview of Reusability Standards
1616

17-
In this document we are adopting the [National Academies of Sciences, Engineering and Medicine 2019 report on Reproducibility and Replicability in Science](https://doi.org/10.17226/25303) definitions of reproducibility and replicability.
17+
In this document we are adopting the [National Academies of Sciences, Engineering and Medicine 2019 report on Reusability and Replicability in Science](https://doi.org/10.17226/25303) definitions of Reusability and replicability.
1818

19-
> Reproducibility means obtaining consistent computational results using the same input data, computational steps, methods, code, and conditions of analysis. Replicability means obtaining consistent results across studies aimed at answering the same scientific question, each of which has obtained its own data.
19+
> Reusability means obtaining consistent computational results using the same input data, computational steps, methods, code, and conditions of analysis. Replicability means obtaining consistent results across studies aimed at answering the same scientific question, each of which has obtained its own data.
2020
21-
Reproducibility is a cornerstone of scientific research, especially for transparent evaluation of research claims. Equally important is the potential for scientific procedures to be reused and modified in order to carry out new research. While clear documentation is essential to reusability, new technologies also offer the potential to increase the reproducibility and reusability of model code.
21+
Reusability is a cornerstone of scientific research, especially for transparent evaluation of research claims. Equally important is the potential for scientific procedures to be reused and modified in order to carry out new research. While clear documentation is essential to reusability, new technologies also offer the potential to increase the Reusability and reusability of model code.
2222

23-
A critical metric of reproducibility is whether a model can consistently reproduce the published results that claim to have been generated by the model. Reproducibility and reusability can also be enhanced if model code is accompanied by explicit workflows that demonstrate how the model generates and transforms its output data into its published findings.
23+
A critical metric of Reusability is whether a model can consistently reproduce the published results that claim to have been generated by the model. Reusability and reusability can also be enhanced if model code is accompanied by explicit workflows that demonstrate how the model generates and transforms its output data into its published findings.
2424

25-
## Goals for Reproducibility Standards
25+
## Goals for Reusability Standards
2626

27-
An independent reviewer should be able to easily download, build, and execute a computational model and verify that it meets the reproducibility claims stated by the model author(s).
27+
An independent reviewer should be able to easily download, build, and execute a computational model and verify that it meets the Reusability claims stated by the model author(s).
2828

29-
## Minimal Reproducibility Standards
29+
## Minimal Reusability Standards
3030

31-
This set of minimal standards also can be adopted by journals to ensure that submitted publications meet baseline reproducibility and reusability requirements.
31+
This set of minimal standards also can be adopted by journals to ensure that submitted publications meet baseline Reusability and reusability requirements.
3232

3333
Computational models must:
3434

@@ -41,14 +41,14 @@ Computational models must:
4141
- software with large compute or data requirements can be problematic:
4242
- provide representative input data samples along with sampling methodology
4343
- provide durable link to wholetale or other provenance-tracked computation
44-
- clearly describe what reproducibility measures or metrics are applicable to the given software
44+
- clearly describe what Reusability measures or metrics are applicable to the given software
4545
- provide range of acceptable outcomes for software with stochastic components
4646
- provide descriptions of possible input parameters and expected outputs with units and format (e.g., shape, data type, etc.)
4747
- include output analyses and workflows
4848
- scripts to transform raw data -> intermediate -> figures
4949
- subsets of intermediate data if prohibitive to generate
5050

51-
## Ideal Reproducibility Standards
51+
## Ideal Reusability Standards
5252

5353
In order to meet the ideal standards, computational models should:
5454

@@ -58,7 +58,7 @@ In order to meet the ideal standards, computational models should:
5858
- include metadata on related research outputs (publications, other software, relationship)
5959
- additional domain specific standards if any (examples?)
6060

61-
## Cyberinfrastructure and Tools for Implementation of Reproducibility Standards
61+
## Cyberinfrastructure and Tools for Implementation of Reusability Standards
6262

6363
Build Docker images from research code:
6464
- stencila/dockta https://github.com/stencila/dockta
@@ -74,9 +74,9 @@ Archive computational pipelines:
7474
OMF may consider building some github template repositories or scaffolding for common modeling frameworks that reduce friction of adoption.
7575
- e.g., https://github.com/uwescience/shablona and https://github.com/geodynamics/software_template
7676
- a GitHub bot that submits PRs against a GitHub repository to improve compliance with minimal / ideal standards
77-
- e.g. provide a cookiecutter project structure that supports best practices for reproducibility and reusability like [Cookiecutter Data Science](http://drivendata.github.io/cookiecutter-data-science/)
77+
- e.g. provide a cookiecutter project structure that supports best practices for Reusability and reusability like [Cookiecutter Data Science](http://drivendata.github.io/cookiecutter-data-science/)
7878

79-
## Examples and References for Reproducibility
79+
## Examples and References for Reusability
8080

8181
- [Lorena Barba's reproducible workflow for computational fluid dynamics](https://doi.org/10.5281/zenodo.2642710) https://github.com/barbagroup/cloud-repro
8282
- https://www.practicereproducibleresearch.org/

0 commit comments

Comments
 (0)