RO-Crate 1.1.3

RO-Crate Metadata Specification 1.1.3

• Permalink: https://w3id.org/ro/crate/1.1
• Published: 2023-04-26
• Publisher: researchobject.org community
• Status: Recommendation
• JSON-LD context: https://w3id.org/ro/crate/1.1/context
• This version: https://w3id.org/ro/crate/1.1
• Alternate formats: Web pages,
  single-page HTML,
  PDF,
  RO-Crate JSON-LD, RO-Crate HTML
• Previous version: https://w3id.org/ro/crate/1.0
• Cite as: https://doi.org/10.5281/zenodo.7867028 (this version)
  https://doi.org/10.5281/zenodo.3406497 (any version)
• Editors: Peter Sefton, Eoghan Ó Carragáin, Stian Soiland-Reyes
• Authors: Peter Sefton, Eoghan Ó Carragáin, Stian Soiland-Reyes, Oscar Corcho, Daniel Garijo, Raul Palma, Frederik Coppens, Carole Goble, José María Fernández, Kyle Chard, Jose Manuel Gomez-Perez, Michael R Crusoe, Ignacio Eguinoa, Nick Juty, Kristi Holmes, Jason A. Clark, Salvador Capella-Gutierrez, Alasdair J. G. Gray, Stuart Owen, Alan R Williams, Giacomo Tartari, Finn Bacall, Thomas Thelen, Hervé Ménager, Laura Rodríguez Navas, Paul Walk, brandon whitehead, Mark Wilkinson, Paul Groth, Erich Bremer, LJ Garcia Castro, Karl Sebby, Alexander Kanitz, Ana Trisovic, Gavin Kennedy, Mark Graves, Jasper Koehorst, Simone Leo, Marc Portier, Paul Brack, Milan Ojsteršek, Bert Droesbeke, Chenxu Niu, Kosuke Tanabe, Tomasz Miksa, Marco La Rosa, Cedric Decruw, Andreas Czerniak, Jeremy Jay, Sergio Serra, Ronald Siebes, Shaun de Witt, Shady El Damaty, Douglas Lowe, Xuanqi Li, Sveinung Gundersen, Muhammad Radifar

This document specifies a method, known as RO-Crate (Research Object Crate), of aggregating and describing research data with associated metadata. RO-Crates can aggregate and describe any resource including files, URI-addressable resources, or use other addressing schemes to locate digital or physical data. RO-Crates can describe data in aggregate and at the individual resource level, with metadata to aid in discovery, re-use and long term management of data. Metadata includes the ability to describe the context of data and the entities involved in its production, use and reuse. For example: who created it, using which equipment, software and workflows, under what licenses can it be re-used, where was it collected, and/or where is it about.

RO-Crate uses JSON-LD to to express this metadata using linked data, describing data resources as well as contextual entities such as people, organizations, software and equipment as a series of linked JSON-LD objects - using common published vocabularies, chiefly schema.org.

The core of RO-Crate is a JSON-LD file, the RO-Crate Metadata File, named ro-crate-metadata.json. 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.

Changelog

• RO-Crate 1.1.3
  • JSON-LD context https://w3id.org/ro/crate/1.1/context fix typo in mapping from RepositoryObject to http://pcdm.org/2016/04/18/models#Object #243 -- not …#object

Note that this release is otherwise identical to 1.1.2 and therefore the remaining files still refer to 1.1.2.

RO-Crate 1.1.2

RO-Crate Metadata Specification 1.1.2

• Permalink: https://w3id.org/ro/crate/1.1
• Published: 2022-01-19
• Publisher: researchobject.org community
• Status: Recommendation
• JSON-LD context: https://w3id.org/ro/crate/1.1/context
• This version: https://w3id.org/ro/crate/1.1
• Alternate formats: Web pages,
  single-page HTML,
  PDF,
  RO-Crate JSON-LD, RO-Crate HTML
• Previous version: https://w3id.org/ro/crate/1.0
• Cite as: https://doi.org/10.5281/zenodo.5841615 (this version)
  https://doi.org/10.5281/zenodo.3406497 (any version)
• Editors: Peter Sefton, Eoghan Ó Carragáin, Stian Soiland-Reyes
• Authors: Peter Sefton, Eoghan Ó Carragáin, Stian Soiland-Reyes, Oscar Corcho, Daniel Garijo, Raul Palma, Frederik Coppens, Carole Goble, José María Fernández, Kyle Chard, Jose Manuel Gomez-Perez, Michael R Crusoe, Ignacio Eguinoa, Nick Juty, Kristi Holmes, Jason A. Clark, Salvador Capella-Gutierrez, Alasdair J. G. Gray, Stuart Owen, Alan R Williams, Giacomo Tartari, Finn Bacall, Thomas Thelen, Hervé Ménager, Laura Rodríguez Navas, Paul Walk, brandon whitehead, Mark Wilkinson, Paul Groth, Erich Bremer, LJ Garcia Castro, Karl Sebby, Alexander Kanitz, Ana Trisovic, Gavin Kennedy, Mark Graves, Jasper Koehorst, Simone Leo, Marc Portier, Paul Brack, Milan Ojsteršek, Bert Droesbeke, Chenxu Niu, Kosuke Tanabe, Tomasz Miksa, Marco La Rosa, Cedric Decruw, Andreas Czerniak, Jeremy Jay, Sergio Serra, Ronald Siebes, Shaun de Witt, Shady El Damaty, Douglas Lowe, Xuanqi Li, Sveinung Gundersen, Muhammad Radifar

This document specifies a method, known as RO-Crate (Research Object Crate), of aggregating and describing research data with associated metadata. RO-Crates can aggregate and describe any resource including files, URI-addressable resources, or use other addressing schemes to locate digital or physical data. RO-Crates can describe data in aggregate and at the individual resource level, with metadata to aid in discovery, re-use and long term management of data. Metadata includes the ability to describe the context of data and the entities involved in its production, use and reuse. For example: who created it, using which equipment, software and workflows, under what licenses can it be re-used, where was it collected, and/or where is it about.

RO-Crate uses JSON-LD to to express this metadata using linked data, describing data resources as well as contextual entities such as people, organizations, software and equipment as a series of linked JSON-LD objects - using common published vocabularies, chiefly schema.org.

The core of RO-Crate is a JSON-LD file, the RO-Crate Metadata File, named ro-crate-metadata.json. 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.

Changelog

• RO-Crate 1.1.2
  • Typo fixes in data entity section #177, workflow section #180, metadata section #181 and others.
  • Correct namespace for rdfs:comment on ad-hoc terms #164
  • Fixed broken links to Bioschemas and SPAR ontologies #185 (note: conformsTo URIs unchanged, will be updated in RO-Crate 1.2)

RO-Crate 1.1.1

RO-Crate Metadata Specification 1.1.1

• Permalink: https://w3id.org/ro/crate/1.1
• Published: 2020-10-30
• Last updated: 2021-02-15
• Publisher: researchobject.org community
• Status: Recommendation
• JSON-LD context: https://w3id.org/ro/crate/1.1/context
• This version: https://w3id.org/ro/crate/1.1
• Alternate formats: Web pages,
  single-page HTML,
  PDF,
  RO-Crate JSON-LD, RO-Crate HTML
• Previous version: https://w3id.org/ro/crate/1.0
• Cite as: https://doi.org/10.5281/zenodo.4541002 (this version)
  https://doi.org/10.5281/zenodo.3406497 (any version)
• Editors: Peter Sefton, Stian Soiland-Reyes
• Authors: Peter Sefton, Eoghan Ó Carragáin, Stian Soiland-Reyes, Oscar Corcho, Daniel Garijo, Raul Palma, Frederik Coppens, Carole Goble, José María Fernández, Kyle Chard, Jose Manuel Gomez-Perez, Michael R Crusoe, Ignacio Eguinoa, Nick Juty, Kristi Holmes, Jason A. Clark, Salvador Capella-Gutierrez, Alasdair J. G. Gray, Stuart Owen, Alan R Williams, Giacomo Tartari, Finn Bacall, Thomas Thelen, Hervé Ménager, Laura Rodríguez Navas, Paul Walk, brandon whitehead, Mark Wilkinson, Paul Groth, Erich Bremer, LJ Garcia Castro, Karl Sebby, Alexander Kanitz, Ana Trisovic, Gavin Kennedy, Mark Graves, Jasper Koehorst, Simone Leo, Marc Portier

This document specifies a method, known as RO-Crate (Research Object Crate), of aggregating and describing research data with associated metadata. RO-Crates can aggregate and describe any resource including files, URI-addressable resources, or use other addressing schemes to locate digital or physical data. RO-Crates can describe data in aggregate and at the individual resource level, with metadata to aid in discovery, re-use and long term management of data. Metadata includes the ability to describe the context of data and the entities involved in its production, use and reuse. For example: who created it, using which equipment, software and workflows, under what licenses can it be re-used, where was it collected, and/or where is it about.

RO-Crate uses JSON-LD to to express this metadata using linked data, describing data resources as well as contextual entities such as people, organizations, software and equipment as a series of linked JSON-LD objects - using common published vocabularies, chiefly schema.org.

The core of RO-Crate is a JSON-LD file, the RO-Crate Metadata File, named ro-crate-metadata.json. 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.

Changelog

• Introduction highlight not all Data entities are files #125 #127

RO-Crate 1.1.0

RO-Crate Metadata Specification 1.1

• Permalink: https://w3id.org/ro/crate/1.1
• Published: 2020-10-30
• Publisher: researchobject.org community
• Status: Recommendation
• JSON-LD context: https://w3id.org/ro/crate/1.1/context
• This version: https://w3id.org/ro/crate/1.1
• Alternate formats: Web pages,
  single-page HTML,
  PDF,
  RO-Crate JSON-LD, RO-Crate HTML
• Previous version: https://w3id.org/ro/crate/1.0
• Cite as: https://doi.org/10.5281/zenodo.4031327 (this version)
  https://doi.org/10.5281/zenodo.3406497 (any version)
• Editors: Peter Sefton, Stian Soiland-Reyes
• Authors: Peter Sefton, Eoghan Ó Carragáin, Stian Soiland-Reyes, Oscar Corcho, Daniel Garijo, Raul Palma, Frederik Coppens, Carole Goble, José María Fernández, Kyle Chard, Jose Manuel Gomez-Perez, Michael R Crusoe, Ignacio Eguinoa, Nick Juty, Kristi Holmes, Jason A. Clark, Salvador Capella-Gutierrez, Alasdair J. G. Gray, Stuart Owen, Alan R Williams, Giacomo Tartari, Finn Bacall, Thomas Thelen, Hervé Ménager, Laura Rodríguez Navas, Paul Walk, brandon whitehead, Mark Wilkinson, Paul Groth, Erich Bremer, LJ Garcia Castro, Karl Sebby, Alexander Kanitz, Ana Trisovic, Gavin Kennedy, Mark Graves, Jasper Koehorst, Simone Leo

This document specifies a method, known as RO-Crate (Research Object Crate), of organizing file-based data with associated metadata, using linked data 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.json. 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.

Changelog

• Note: The RO-Crate metadata file is renamed to ro-crate-metadata.json to facilitate use of JSON editors. #82 #84
• Data entities can reference external resources with absolute URI #74
• Added section on considerations for Web-based Data Entities #74
• The root dataset is no longer required to be ./ #74
• RO-Crate Root directory no longer requires payload files #74
• Workflows and scripts section now aligned with BioSchemas ComputationalWorkflow profile #81 #100
• Added section Programming with JSON-LD and note that @type might be an array #85
• Added new section Handling relative URI references #73
• JSON-LD context no longer sets @base: null #73
• Added note on Encoding file paths #77 #80
• Added section Choosing URLs for ad hoc terms #71 #90
• Section RO-Crate JSON-LD Media type expanded to suggest HTTP server configuration
• Update JSON-LD context to schema.org 10.0
• Remove HTML use of relatedLink property in RepositoryCollection example #91
• Distinguish between contextual/data entities #94
• RO-Crate preview HTML no longer needs to "contain same information as JSON-LD" #108
• Change theme to jekyll-rtd-theme and split into multiple pages #95
• Fixed typos in JSON and English
• Additional metadata standards showed wrong PCDM namespace #112
• Citation example expanded 12a6754
• Terminology adds property, type, entity cc10e28
• In People author can also be applied to CreativeWork e086b8b
• Provenance section on Software-used now points to Workflows section (and vice versa) 5d89872 40de6c7
• In JSON-LD appendix @id should not include ../ 74ef6f1
• Several sections reviewed to improve language and examples #91 #92 #93 #94 #96 #97 #98 #101 #102 #103 #104 #105 #111
  #114

RO-Crate 1.1.0 (release candidate 2)

Note: Release candidate preview before release later on 2020-10-30

RO-Crate Metadata Specification 1.1 RC2

• Permalink: https://w3id.org/ro/crate/1.1 TODO, see https://stain.github.io/ro-crate/1.1-RC2/
• Published: 2020-10-30
• Publisher: researchobject.org community
• Status: Recommendation
• JSON-LD context: https://w3id.org/ro/crate/1.1-RC2/context TODO, see https://stain.github.io/ro-crate/1.1-RC2/context.jsonld
• This version: https://w3id.org/ro/crate/1.1-RC2 TODO, see https://stain.github.io/ro-crate/1.1-RC2/
• Alternate formats: Web pages,
  single-page HTML,
  PDF,
  RO-Crate JSON-LD, RO-Crate HTML
• Previous version: https://w3id.org/ro/crate/1.0
• Cite as: https://doi.org/10.5281/zenodo.4031327 (this version) TODO
  https://doi.org/10.5281/zenodo.3406497 (any version)
• Editors: Peter Sefton, Eoghan Ó Carragáin, Stian Soiland-Reyes
• Authors: Peter Sefton, Eoghan Ó Carragáin, Stian Soiland-Reyes, Oscar Corcho, Daniel Garijo, Raul Palma, Frederik Coppens, Carole Goble, José María Fernández, Kyle Chard, Jose Manuel Gomez-Perez, Michael R Crusoe, Ignacio Eguinoa, Nick Juty, Kristi Holmes, Jason A. Clark, Salvador Capella-Gutierrez, Alasdair J. G. Gray, Stuart Owen, Alan R Williams, Giacomo Tartari, Finn Bacall, Thomas Thelen, Hervé Ménager, Laura Rodríguez Navas, Paul Walk, brandon whitehead, Mark Wilkinson, Paul Groth, Erich Bremer, LJ Garcia Castro, Karl Sebby, Alexander Kanitz, Ana Trisovic, Gavin Kennedy, Mark Graves, Jasper Koehorst, Simone Leo

This document specifies a method, known as RO-Crate (Research Object Crate), of organizing file-based data with associated metadata, using linked data 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.json. 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.

Changelog

• Note: The RO-Crate metadata file is renamed to ro-crate-metadata.json to facilitate use of JSON editors. #82 #84
• Data entities can reference external resources with absolute URI #74
• Added section on considerations for Web-based Data Entities #74
• The root dataset is no longer required to be ./ #74
• RO-Crate Root directory no longer requires payload files #74
• Workflows and scripts section now aligned with BioSchemas ComputationalWorkflow profile #81 #100
• Added section Programming with JSON-LD and note that @type might be an array #85
• Added new section Handling relative URI references #73
• JSON-LD context no longer sets @base: null #73
• Added note on Encoding file paths #77 #80
• Added section Choosing URLs for ad hoc terms #71 #90
• Section RO-Crate JSON-LD Media type expanded to suggest HTTP server configuration
• Update JSON-LD context to schema.org 10.0
• Remove HTML use of relatedLink property in RepositoryCollection example #91
• Distinguish between contextual/data entities #94
• RO-Crate preview HTML no longer needs to "contain same information as JSON-LD" #108
• Change theme to jekyll-rtd-theme and split into multiple pages #95
• Fixed typos in JSON and English
• Additional metadata standards showed wrong PCDM namespace #112
• Citation example expanded 12a6754
• Terminology adds property, type, entity cc10e28
• In People author can also be applied to CreativeWork e086b8b
• Provenance section on Software-used now points to Workflows section (and vice versa) 5d89872 40de6c7
• In JSON-LD appendix @id should not include ../ 74ef6f1
• Several sections reviewed to improve language and examples #91 #92 #93 #94 #96 #97 #98 #101 #102 #103 #104 #105 #111
  #114

RO-Crate 1.1.0 (release candidate 1)

Note: Release candidate under vote until 2020-10-26, see #109

RO-Crate Metadata Specification 1.1 RC1

• Permalink: https://w3id.org/ro/crate/1.1
• Status: Recommendation
• Published: 2020-10-22
• Publisher: researchobject.org community
• Status: Recommendation
• JSON-LD context: https://stain.github.io/ro-crate/1.1-RC1/context.jsonld
• This version: https://w3id.org/ro/crate/1.1
• Alternate formats: Web pages,
  single-page HTML,
  PDF,
  RO-Crate JSON-LD, RO-Crate HTML
• Previous version: https://w3id.org/ro/crate/1.0
• Cite as: https://doi.org/10.5281/zenodo.4031327 (this version)
  https://doi.org/10.5281/zenodo.3406497 (any version)
• Editors: Peter Sefton, Eoghan Ó Carragáin, Stian Soiland-Reyes
• Authors: Peter Sefton, Eoghan Ó Carragáin, Stian Soiland-Reyes, Oscar Corcho, Daniel Garijo, Raul Palma, Frederik Coppens, Carole Goble, José María Fernández, Kyle Chard, Jose Manuel Gomez-Perez, Michael R Crusoe, Ignacio Eguinoa, Nick Juty, Kristi Holmes, Jason A. Clark, Salvador Capella-Gutierrez, Alasdair J. G. Gray, Stuart Owen, Alan R Williams, Giacomo Tartari, Finn Bacall, Thomas Thelen, Hervé Ménager, Laura Rodríguez Navas, Paul Walk, brandon whitehead, Mark Wilkinson, Paul Groth, Erich Bremer, LJ Garcia Castro, Karl Sebby, Alexander Kanitz, Ana Trisovic, Gavin Kennedy, Mark Graves, Jasper Koehorst

This document specifies a method, known as RO-Crate (Research Object Crate), of organizing file-based data with associated metadata, using linked data 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.json. 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.

Changelog

• Note: The RO-Crate metadata file is renamed to ro-crate-metadata.json to facilitate use of JSON editors. #82 #84
• Data entities can reference external resources with absolute URI #74
• Added section on considerations for Web-based Data Entities #74
• The root dataset is no longer required to be ./ #74
• RO-Crate Root directory no longer requires payload files #74
• Workflows and scripts section now aligned with BioSchemas ComputationalWorkflow profile #81 #100
• Added section Programming with JSON-LD and note that @type might be an array #85
• Added new section Handling relative URI references #73
• JSON-LD context no longer sets @base: null #73
• Added note on Encoding file paths #77 #80
• Added section Choosing URLs for ad hoc terms #71 #90
• Section RO-Crate JSON-LD Media type expanded to suggest HTTP server configuration
• Update JSON-LD context to schema.org 10.0
• Remove HTML use of relatedLink property in RepositoryCollection example #91
• Distinguish between contextual/data entities #94
• RO-Crate preview HTML no longer needs to "contain same information as JSON-LD" #108
• Change theme to jekyll-rtd-theme and split into multiple pages #95
• Fixed typos in JSON and English
• Several sections reviewed to improve language and examples #91 #92 #93 #94 #96 #97 #98 #101 #102 #103 #104 #105

RO-Crate Metadata Specification 1.0.0

• Permalink: https://w3id.org/ro/crate/1.0
• Status: Recommendation
• JSON-LD context: https://w3id.org/ro/crate/1.0/context
• This version: https://w3id.org/ro/crate/1.0
• Previous version: https://w3id.org/ro/crate/0.2
• Published: 2019-11-15
• Publisher: researchobject.org community
• Cite as: https://doi.org/10.5281/zenodo.3541888 (this version)
  https://doi.org/10.5281/zenodo.3406497 (any version)
• Editors: Peter Sefton, Eoghan Ó Carragáin, Stian Soiland-Reyes
• Authors: Peter Sefton, Eoghan Ó Carragáin, Stian Soiland-Reyes, Oscar Corcho, Daniel Garijo, Raul Palma, Frederik Coppens, Carole Goble, José María Fernández, Kyle Chard, Jose Manuel Gomez-Perez, Michael R Crusoe, Ignacio Eguinoa, Nick Juty, Kristi Holmes, Jason A. Clark, Salvador Capella-Gutierrez, Alasdair J. G. Gray, Stuart Owen, Alan R Williams, Giacomo Tartari, Finn Bacall, Thomas Thelen

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

RO-Crate Metadata Specification 0.2.1

• Permalink: https://w3id.org/ro/crate/0.2
• Cite as: https://doi.org/10.5281/zenodo.3406498 (this version)
  https://doi.org/10.5281/zenodo.3406497 (any version)
• JSON-LD context: https://w3id.org/ro/crate/0.2/context
• Status: Working Draft
• Publisher: researchobject.org community
• Published: 2019-09-12
• Editors: Peter Sefton, Eoghan Ó Carragáin, Stian Soiland-Reyes
• Authors: Peter Sefton, Eoghan Ó Carragáin, Stian Soiland-Reyes, Oscar Corcho, Daniel Garijo, Raul Palma, Frederik Coppens, Carole Goble, José María Fernández, Kyle Chard, Jose Manuel Gomez-Perez, Michael R Crusoe, Ignacio Eguinoa, Nick Juty, Kristi Holmes, Jason A. Clark, Salvador Capella-Gutierrez, Alasdair J. G. Gray, Stuart Owen, Alan R Williams

This document specifies a method, known as RO-Crate (Research Object Crate), of organizing file-based data with associated metadata, using linked data 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

This release is based on two earlier specifications:

• RO Lite 0.1.0
• DataCrate Specification version 1.0.0 2019-04-12

Notable changes include:

• RO-Crate Metadata file has been renamed to ro-crate-metadata.jsonld instead of CATALOG.json (DataCrate) or manifest.jsonld (RO-Lite)
• RO Crate Website renamed to ro-crate-metadata.html instead of DataCrate's CATALOG.html
• "RO-Lite" and "DataCrate" renamed to "RO-Crate"
• Multiple examples and clarifications added
• RO-Crate directory no longer requires BagIt structure
• Added section on Workflows and scripts
• RO-Crate Metadata File must describe itself as being about the RO-Crate Dataset.
• JSON-LD should now be flattened and then compacted (RO-Lite allowed any JSON-LD, DataCrate required flattened)

RO-Crate Metadata Specification 0.2.0

Cite as: https://doi.org/10.5281/zenodo.3406498