The RO-Crate structure is that a RO-Crate root directory has a RO-Crate Metadata File named
ro-crate-metadata.json that describe the other files, directories and URLs; as well as relating them to things in the world (e.g. people, instruments).
From RO-Crate 1.1
The specification has several inline examples:
- Skeleton ro-crate-metadata.json
- Minimal example
- Example with files
- Example with web resources
- Example with file, author, location
- Example with computational workflow
- RO-Crate specification (ro-crate-metadata.jsonld) – the specification itself and its publication
The RO-Crate 1.1 specification is largely explained by examples by showing additional fragments:
- Data entities (files, folders)
- Web resources
- Contextual entities such as people, organizations, citations, licensing, places
- Section on provenance details how the creation of resources can be recorded
- Computational workflows and scripts can be further described showing programming language, inputs, outputs, etc.
- The RO-Crate JSON-LD can be extended for additional vocabularies, including ad-hoc terms
- Section on combining with other packaging schemas explain how an RO-Crate can be packaged in a single archive using BagIt
The Arkisto platform case studies highlight multiple ways RO-Crate has been used:
- PARADISEC (the Pacific And Regional Archive for Digital Sources in Endangered Cultures) deployed on http://mod.paradisec.org.au/ (example ro-crate-metadata.jsonld via OCFL)
You can also look at some example RO-Crates.
Some of the below examples may be using RO-Crate 0.2, which may miss some subtle changes in RO-Crate 1.0 and RO-Crate 1.1. Implementers are advised to check relevant sections in the latest RO-Crate specification.
- Recordings in South Efate (ro-crate-metadata.jsonld) – one of more than 14k RO-Crates from the Pacific and Regional Archive for Digital Sources in Endangered Cultures (beta)
- Dataset for IDRC Project: Exploring the opportunities and challenges of implementing open research strategies within development institutions (ro-crate-metadata.jsonld)
- Dataset, Book: Pioneer Work in the Alps of New Zealand (ro-crate-metadata.jsonld)
- Glop Pot data (ro-crate-metadata.jsonld) – shows how Calcyte’s preview HTML can nest folders
- Dharmae Example Dataset (ro-crate-metadata.jsonld) – shows how RO-Crate can carry rich metadata for individual resources which can have multiple representations
The https://workflowhub.eu/ accepts upload by RO-Crate and generates RO-Crate to improve reproducability of computational workflow that follow the Workflow RO-Crate profile, see also RO-Crate section on workflows.
Workflows can be exported from Workflow Hub as RO-Crates, e.g. a Galaxy workflow. Workflows can also be navigated programmatically using the TRS API, e.g. https://workflowhub.eu/ga4gh/trs/v2/tools/26/versions/1/PLAIN_CWL/descriptor/ro-crate-metadata.jsonld
https://github.com/biocompute-objects/bco-ro-example-chipseq hosts an example RO-Crate (ro-crate-metadata.json, ro-crate-preview.html) that capture a BioCompute Object (IEEE 2791) using BagIt. See the tutorial Create an BCO RO-Crate for step-by-step details.