Skip to content

RO-Crate Metadata Specification 1.0.0

Compare
Choose a tag to compare
@stain stain released this 14 Nov 18:46
1.0.0
986a56e

This document specifies a method, known as RO-Crate (Research Object Crate), of organizing file-based data with associated metadata, using LinkedData principles, in both human and machine readable formats, with the ability to include additional domain-specific metadata.

The core of RO-Crate is a JSON-LD file, the RO-Crate Metadata File, named ro-crate-metadata.jsonld. This file contains structured metadata about the dataset as a whole (the Root Data Entity) and, optionally, about some or all of its files. This provides a simple way to, for example, assert the authors (e.g. people, organizations) of the RO-Crate or one its files, or to capture more complex provenance for files, such as how they were created using software and equipment.

While providing the formal specification for RO-Crate, this document also aims to be a practical guide for software authors to create tools for generating and consuming research data packages, with explanation by examples.

Changes

  • Description of RO-Crate Metadata File now required
    • .. must use conformsTo to indicate RO-Crate version
  • Clarified use of RO-Crate JSON-LD Context
  • Linked Data principles added
  • RO-Crate JSON-LD Context updated to use schema.org 5.0
  • Workflow and Script now typed with @type array instead of additionalType
  • Simplified tables of direct properties to list of properties
  • Simplified example of affiliation
  • Clarified #identifiers and _:identifiers
  • Removed links to data.research.uts.edu.au examples
  • Added licensing of metadata
  • Expanded on Equipment used to create files
  • Simplified Workflow and Script section
  • Added appendix on JSON-LD
  • Added BagIt implementation notes
  • Added Repository-specific identifiers
  • RO-Crate JSON-LD now licensed CC0
  • RO-Crate JSON-LD self-identifies its version