|
|
Reproducibility Tier |
Research Stage |
Feature |
0 - Traditional Report |
I - Reviewable |
II - Confirmable |
III - Computable |
IV - Preservable |
V - Automatically Verifiable |
Analysis Plan |
Availability |
|
A written description of the analysis plan is distributable |
Analysis plan is registered |
Analysis plan registration is accompanied by relevant analysis code |
Analysis plan registration and accompanying code includes data fixtures and tests |
Permissions |
|
Analysis plan is licensed allowing, minimally, viewing of the content |
Materials and/or code is licensed using an approved license |
Data Collection Plan |
Availability |
|
A written description of the data collection plan is distributable |
Data collection plan is registered |
Data collection plan is accompanied by relevant materials |
Permissions |
|
Data collection plan is licensed allowing, minimally, viewing of the content |
Materials and/or code is licensed using an approved license |
Data Collection |
Availability |
|
A written description of the materials are distributable |
Materials/code is made public |
Materials/code are assigned a persistent ID and deposited in a trusted repository |
Materials/code are accompanied by rich metadata as well a codebook or data dictionary |
Permissions |
|
Materials and/or code is licensed allowing, minimally, viewing of the content |
Materials/code are licensed using an approved license |
Data |
Availability |
|
A written description of the data is distributable |
Data is shared |
Raw data generated during the project is shared |
Raw data is accompanied by rich metadata including provenance information |
Permissions |
|
Data is licensed allowing, minimally, viewing of the content |
Data is licensed using an approved license |
Data Cleaning |
Availability |
|
A written description of the data clean process is distributable |
Code is made public |
Code is in a public version control system; exact version is reported |
The repository is made available in an archivable format |
Code includes tests |
Permissions |
|
Code is licensed allowing, minimally, viewing of the content |
Code is licensed using an OSI-approved license |
Software |
|
Documentation of exact versions of software and dependencies used |
Software is installed/updated with a script |
Dependencies are archived, bundled, or captured in an image or container for preservation |
Environment |
|
Documentation of the computing environment with versions is provided |
The environment is built with a script |
A virtual machine, container, or emulated environment is provided |
Data Analysis |
Availability |
|
A written description of the data analysis process is distributable |
Code is made public |
Code is in a public, software version control system (e.g., git, Github, Gitlab, BitBucket); exact version is reported |
The repository is made available in an archivable format |
Code includes tests |
Permissions |
|
Code is licensed allowing, minimally, viewing of the content |
Code is licensed using an OSI-approved license |
Code is well documented |
Software |
|
Documentation of exact versions of software and dependencies used |
Software is installed/updated with a script |
Dependencies are archived, bundled, or captured in an image or container for preservation |
Environment |
|
Documentation of the computing environment with versions is provided |
The environment is built with a script |
A virtual machine, container, or emulated environment is provided, perhaps as part of the bundle created for software |
Workflow/ Reporting |
Availability |
|
A written description of the research workflow is distributable |
References to each state of the research workflow are included |
Components of the report are easily related to what has been computed |
Literate programming generates the report |
Permissions |
|
Report is licensed allowing, minimally, viewing of the content |
Report is licensed using an approved license (e.g., CC0, CC-BY) |