RO-CRATE - Revision history

Ross-spencer: /* RO-CRATE file format */

2025-03-24T10:09:49Z

‎RO-CRATE file format

Ross-spencer: Spelling

2025-02-07T11:36:57Z

Spelling

Ross-spencer: Add links to examples

2025-02-07T11:26:15Z

Add links to examples

Ross-spencer: Add RO-CRATE

2025-02-06T13:56:13Z

Add RO-CRATE

New page

{{FormatInfo
|formattype=electronic
|subcat=
|extensions={{ext|jsonld}}{{ext|json}}
|mimetypes={{mimetype|application/ld+json}}
|pronom=
|wikidata={{wikidata|Q124366860}}
|released=2017
}}

'''RO-CRATE''' ('''Research Object Crate''') is a packaging standard and metadata designed to describe research data and its inter-dependencies.

== About ==

RO-CRATE specifies a metadata file that must use the filename <code>ro-crate-metadata.json</code>. The <code>ro-crate-metadata.json</code> file's presence in a directory identifies the root directory of a RO-CRATE object. The name of the containing directory is not fixed. Version 1.0 and before defined the root with a <code>.jsonld</code> extension, so: <code>ro-crate-metadata.jsonld</code>.

RO-CRATE's metadata file describes data entries (files, directories) and contextual entities (licenses, authorship, funding, instrumentation, etc.). As linked data, the packaging format describes a graph of the package's content and its links to contextual information about its content. Its goal to enable reproducible, transparent, research.

== RO-CRATE structure ==

The RO-CRATE package structure looks as follows.

<pre>
<RO-Crate root directory>/
| ro-crate-metadata.json # RO-Crate Metadata File MUST be present
| ro-crate-preview.html # RO-Crate Website homepage MAY be present
| ro-crate-preview_files/ # MAY be present
| | [other RO-Crate Website files]
| [payload files and directories] # 0 or more
</pre>

=== RO-Crate Website homepage ===

Provides a human readable view of the RO-CRATE package. Tools exist to help support the creation of this file.

== RO-CRATE specification ==

=== Current version ===

[https://w3id.org/ro/crate/1.1 RO-CRATE 1.1]

=== Previous versions ===

[https://w3id.org/ro/crate/1.0 RO-CRATE 1.0]
[https://w3id.org/ro/crate/0.2 RO-CRATE 0.2]

=== Draft version ===

[https://w3id.org/ro/crate/1.2-DRAFT RO-CRATE 1.2]

== RO-CRATE file format ==

RO-CRATES file is built upon [[JSON]] and [[JSON-LD]]. The structure of the format provides a JSON-LD <code>@context</code> followed by a <code>@graph</code> of its data and contextual entities. The following example the RO-CRATE [https://www.researchobject.org/packaging_data_with_ro-crate/14-complete/index.html Packaging Data with RO-CRATE tutorial].

<pre>
{
"@context": "https://w3id.org/ro/crate/1.1/context",
"@graph": [
{
"@id": "ro-crate-metadata.json",
"@type": "CreativeWork",
"conformsTo": {"@id": "https://w3id.org/ro/crate/1.1"},
"about": {"@id": "./"}
},
{
"@id": "./",
"@type": ["Dataset", "LearningResource"],
"hasPart": [
{"@id": "data.csv"}
],
"name": "Example dataset for RO-Crate specification",
"description": "Official rainfall readings for Katoomba, NSW 2022, Australia",
"datePublished": "2023-05-22T12:03:00+0100",
"license": {"@id": "http://spdx.org/licenses/CC0-1.0"},
"author": { "@id": "https://orcid.org/0000-0002-1825-0097" },
"publisher": {"@id": "https://ror.org/05gq02987"}
},
{
"@id": "data.csv",
"@type": "File",
"name": "Rainfall Katoomba 2022-02",
"description": "Rainfall data for Katoomba, NSW Australia February 2022",
"encodingFormat": "text/csv",
"license": {"@id": "https://creativecommons.org/licenses/by-nc-sa/4.0/"}
},
{
"@id": "https://creativecommons.org/licenses/by-nc-sa/4.0/",
"@type": "CreativeWork",
"name": "CC BY-NC-SA 4.0 International",
"description": "Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International"
},
{
"@id": "http://spdx.org/licenses/CC0-1.0",
"@type": "CreativeWork",
"name": "CC0-1.0",
"description": "Creative Commons Zero v1.0 Universal",
"url": "https://creativecommons.org/publicdomain/zero/1.0/"
},
{
"@id": "https://orcid.org/0000-0002-1825-0097",
"@type": "Person",
"name": "Josiah Carberry",
"affiliation": {
"@id": "https://ror.org/05gq02987"
}
},
{
"@id": "https://ror.org/05gq02987",
"@type": "Organization",
"name": "Brown University",
"url": "http://www.brown.edu/"
}
]
}
</pre>

Identifications based upon this structure might look for the appropriate context for a given version, and existence of the <code>@graph</code> array.

== Use Cases ==

RO-CRATE's use-cases are described on the [https://www.researchobject.org/ro-crate/use_cases RO-CRATE homepage]. Domain uses can be found under this page, ranging from Biology, to Chemistry, History, and Informatics.

== Tools and libraries ==

* [https://github.com//language-research-technology RO-CRATE tooling from LDaCA] on GitHub.
* [https://github.com/ResearchObject Tooling and specifications from the RO-CRATE community] on Github.
* [https://language-research-technology.github.io/crate-o CRATE-O browser based editor]
* [https://www.npmjs.com/package/ro-crate-html RO-CRATE package preview generator]

== Resources ==

* [https://www.researchobject.org/ RO-CRATE homepage]
* [https://www.researchobject.org/ro-crate/specification RO-CRATE specification homepage]
* [https://www.researchobject.org/ro-crate/dataverse Dataverse export of RO-CRATE]
* [https://www.npmjs.com/package/ro-crate-html RO-CRATE Preview (HTML) generation]

← Older revision		Revision as of 10:09, 24 March 2025
Line 116:		Line 116:

	Identifications based upon this structure might look for the appropriate context for a given version, and existence of the <code>@graph</code> array.		Identifications based upon this structure might look for the appropriate context for a given version, and existence of the <code>@graph</code> array.
		+
		+	=== Minimal example ===
		+
		+	A minimal example of a RO-CRATE is described in the [https://www.researchobject.org/ro-crate/specification/1.1/root-data-entity.html#minimal-example-of-ro-crate spec].
		+
		+	<pre>
		+	{ "@context": "https://w3id.org/ro/crate/1.1/context",
		+	"@graph": [
		+
		+	{
		+	"@type": "CreativeWork",
		+	"@id": "ro-crate-metadata.json",
		+	"conformsTo": {"@id": "https://w3id.org/ro/crate/1.1"},
		+	"about": {"@id": "./"}
		+	},
		+	{
		+	"@id": "./",
		+	"identifier": "https://doi.org/10.4225/59/59672c09f4a4b",
		+	"@type": "Dataset",
		+	"datePublished": "2017",
		+	"name": "Data files associated with the manuscript:Effects of facilitated family case conferencing for ...",
		+	"description": "Palliative care planning for nursing home residents with advanced dementia ...",
		+	"license": {"@id": "https://creativecommons.org/licenses/by-nc-sa/3.0/au/"}
		+	},
		+	{
		+	"@id": "https://creativecommons.org/licenses/by-nc-sa/3.0/au/",
		+	"@type": "CreativeWork",
		+	"description": "This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Australia License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/au/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.",
		+	"identifier": "https://creativecommons.org/licenses/by-nc-sa/3.0/au/",
		+	"name": "Attribution-NonCommercial-ShareAlike 3.0 Australia (CC BY-NC-SA 3.0 AU)"
		+	}
		+	]
		+	}
		+	</pre>

	== Example RO-CRATES ==		== Example RO-CRATES ==

@@ Line 51: / Line 51: @@
 == RO-CRATE file format ==
-RO-CRATES file is built upon [[JSON]] and [[JSON-LD]]. The structure of the format provides a JSON-LD <code>@context</code> followed by a <code>@graph</code> of its data and contextual entities. The following example the RO-CRATE [https://www.researchobject.org/packaging_data_with_ro-crate/14-complete/index.html Packaging Data with RO-CRATE tutorial].
+RO-CRATE's metadata file is built upon [[JSON]] and [[JSON-LD]]. The structure of the format provides a JSON-LD <code>@context</code> followed by a <code>@graph</code> of its data and contextual entities. The following example the RO-CRATE [https://www.researchobject.org/packaging_data_with_ro-crate/14-complete/index.html Packaging Data with RO-CRATE tutorial].
 <pre>
@@ Line 115: / Line 115: @@
 </pre>
 Identifications based upon this structure might look for the appropriate context for a given version, and existence of the <code>@graph</code> array.
 == Example RO-CRATES ==

← Older revision		Revision as of 11:26, 7 February 2025
Line 116:		Line 116:

	Identifications based upon this structure might look for the appropriate context for a given version, and existence of the <code>@graph</code> array.		Identifications based upon this structure might look for the appropriate context for a given version, and existence of the <code>@graph</code> array.
		+
		+	== Example RO-CRATES ==
		+
		+	Links to examples can be found on the Research Object website: [https://www.researchobject.org/ro-crate/examples links to complete examples].

	== Use Cases ==		== Use Cases ==