Introduction

Together, we will create a research compendium whilst taking the following ten things into account (by Arguillas et al. 2022, licensed under CC BY 4.0):

Does the research compendium contain everything needed to reproduce a predefined outcome in an organized and parsimonious way?

  1. Completeness: The research compendium contains all of the objects needed to reproduce a predefined outcome.
  2. Organization: It is easy to understand and keep track of the various objects in the research compendium and their relationship over time.
  3. Economy: Fewer extraneous objects in the compendium mean fewer things that can break and require less maintenance over time.

Is descriptive information about the research compendium and its components available and easy to understand?

  1. Transparency: The research compendium provides full disclosure of the research process that produced the scientific claim.
  2. Documentation: Information describing compendium objects is provided in enough detail to enable independent understanding and use of the compendium.

Is information about how the research compendium and its components can be used available and easy to understand?

  1. Access: It is clear who can use what, how, and under what conditions, with open access preferred.
  2. Provenance: The origin of the components of the research compendium and how each has changed over time is evident.

Is information about the research compendium and its components embedded in code?

  1. Metadata: Information about the research compendium and its components is embedded in a standardized, machine-readable code.
  2. Automation: As much as possible, the computational workflow is script- or workflow-based so that the workflow can be re-executed using minimal actions.

Is there a plan for reviewing the research compendium for FAIR and computational reproducibility standards over time?

  1. Review: A series of managed activities are needed to ensure continued access to and functionality of the research compendium and its components for as long as necessary.
Back to top

References

Arguillas, Florio, Thu-Mai Christian, Mandy Gooch, Tom Honeyman, Limor Peer, and CURE-FAIR WG. 2022. “10 Things for Curating Reproducible and FAIR Research.” Research Data Alliance; https://curating4reproducibility.org/10things/. https://doi.org/10.15497/RDA00074.