|
1 | 1 | --- |
2 | | -title: "Reproducible research" |
3 | | -linkTitle: "Reproducibility" |
| 2 | +title: "Repeatable research" |
| 3 | +linkTitle: "Repeatability" |
4 | 4 | weight: 24 |
5 | 5 | categories: |
6 | 6 | - Documentation |
7 | 7 | tags: |
8 | 8 | - Project |
9 | 9 | - Project - concepts |
10 | 10 | description: > |
11 | | - Some core concepts relating to reproducible research have multiple conflicting definitions - this is how we use them. |
| 11 | + Some core concepts relating to repeatable research have multiple conflicting definitions - this is how we use them. |
12 | 12 | --- |
13 | 13 |
|
14 | | -Although there is widespread support from the scientific community on the importance of reproducible research, the definition of key terms such as reproducibility and replicability can vary across disciplines and methodologies (e.g. the extent to which computational modelling is used). In some cases, entirely different terms (e.g. repeatability) are preferred. The meanings we intend when using these terms are described below. |
| 14 | +Although there is widespread support from the scientific community on the importance of repeatable research, the definition of key terms such as reproducibility and replicability can vary across disciplines and methodologies (e.g. the extent to which computational modelling is used). The meanings we intend when using these terms are described below. |
15 | 15 |
|
16 | 16 | ## Reproduction and Replication |
17 | 17 | The distinctions we make between reproduction and replication have been guided by the approach outlined in a report by the [National Academies of Sciences, Engineering and Medicine](https://nap.nationalacademies.org/catalog/25303/reproducibility-and-replicability-in-science). However, we have adapted their definitions slightly as the meanings in that report were framed in terms of study findings / outcomes, whereas our usage relates more to intended objectives when deploying tools. |
18 | 18 |
|
19 | | -### Meanings |
| 19 | +### Our usage |
| 20 | + |
20 | 21 | #### Reproduction |
21 | 22 | Applying the same [analysis](/docs/model/analyses/) code to the same input [data](/docs/model/datasets/) with the expectation of generating identical outputs (with the exception of trivial artefacts like datestamps for when analysis reports were produced). |
22 | 23 |
|
23 | 24 | #### Replication |
24 | 25 | Applying analysis code used in a study to new input data. The analysis code is reused with only minimal edits that are necessary to account for differences in input data paths and variable names and to study metadata (e.g. investigator names, sample descriptions). The new data can be real or fake, but will include the same structure and concepts / measures as those found in the original study's dataset. If the new data is a sample from the same population as the original study, then the expectation when undertaking replications is for results across studies to be broadly similar. |
25 | 26 |
|
26 | | -### Examples |
27 | | -[Examples of both reproduction and replication code](/docs/model/analyses/replication-code/) are available. When publishing analysis code we try to adopt (there are exceptions) the following rules of thumb: |
| 27 | +### Suggested policies |
| 28 | +When publishing analysis code we suggest adopting the following rules of thumb: |
28 | 29 |
|
29 | | -1. If the data required to re-run a study analysis are publicly available (or declared by the analysis program itself), then we publish the code as a reproduction program (e.g. [this program for creating a synthetic population](/docs/model/analyses/replication-code/make-fakes/clinical-primary/)). |
| 30 | +1. If the data required to re-run a study analysis are publicly available (or declared by the analysis program itself), publish the code as a reproduction program (e.g. [this program for creating a synthetic population](https://readyforwhatsnext.org/docs/analyses/replication-code/make-fakes/clinical-primary/)). |
30 | 31 |
|
31 | | -2. If the data required to re-run a study analysis are not publicly available, we publish the replication version of the code. The replication version of the code may be configured to ingest a synthetic (fake) representation of the study dataset as with [this utility mapping replication program](/docs/model/analyses/replication-code/map-utility/ttu_lng_aqol6d_csp/). Details of the (minimal) steps required to revert the replication code to a version that can be used for reproduction purposes are typically embedded within the program itself. |
| 32 | +2. If the data required to re-run a study analysis are not publicly available, we publish the replication version of the code. The replication version of the code may be configured to ingest a synthetic (fake) representation of the study dataset as with [this utility mapping replication program](https://readyforwhatsnext.org/docs/analyses/replication-code/map-utility/ttu_lng_aqol6d_csp/). Details of the (minimal) steps required to revert the replication code to a version that can be used for reproduction purposes are typically embedded within the program itself. |
0 commit comments