ROCrateMetadataElem Model¶
The ROCrateMetadataElem
model represents the "Root Dataset" entity within an RO-Crate. This is the main descriptive node for the crate as a whole, containing high-level metadata such as its name, author, and license. It also uses the hasPart
property to link to all other data and metadata entities packaged within the crate.
Properties¶
Property | Type | Description | Required |
---|---|---|---|
guid (alias: @id ) |
str |
The unique, resolvable identifier for the RO-Crate itself. | Yes |
metadataType (alias: @type ) |
List[str] |
A list of types for the root entity. Typically ["Dataset", "https://w3id.org/EVI#ROCrate"] . |
Yes |
name |
str |
The human-readable name of the RO-Crate. | Yes |
description |
str |
A detailed description of the RO-Crate's content and purpose. | Yes |
keywords |
List[str] |
A list of keywords to aid in the discovery of the crate. | Yes |
isPartOf |
List[IdentifierValue] |
Links to any larger collections or projects this crate is a part of. | Yes |
version |
str |
The version of the RO-Crate. | Yes |
hasPart |
List[IdentifierValue] |
A list of links (by @id ) to every other entity within the crate's @graph . |
Yes |
author |
Union[str, List[str]] |
The person, people, or organization that created the RO-Crate. | Yes |
license (alias: dataLicense ) |
Optional[str] |
A URL pointing to the license under which the data is shared. | No |
associatedPublication |
Union[str, List[str]] |
A URL or citation for a publication associated with the crate. Defaults to an empty string. | No |
conditionsOfAccess |
Optional[str] |
A description of any conditions that must be met to access the data. | No |
copyrightNotice |
Optional[str] |
A formal copyright notice for the crate's contents. | No |
Example¶
{
"@id": "ark:59852/rocrate-data-from-treated-human-cancer-cells/",
"@type": ["Dataset", "https://w3id.org/EVI#ROCrate"],
"name": "Data from: SEC-MS of MDA-MB468 following treatment of vorinostat or paclitaxel.",
"description": "This dataset was generated by size exclusion chromatography-mass spectroscopy...",
"keywords": ["AI", "Breast cancer", "SEC-MS", "vorinostat", "paclitaxel"],
"isPartOf": [
{ "@id": "ark:59852/organization-university-of-california-san-diego" },
{ "@id": "ark:59852/project-cm4ai" }
],
"version": "1.5",
"hasPart": [
{ "@id": "ark:59852/experiment-control-1-sec-ms-mda-mb468" },
{ "@id": "ark:59852/dataset-control-1-sec-ms-mda-mb468" }
],
"author": "Forget A, Obernier K, Krogan N",
"license": "https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en",
"associatedPublication": "http://doi.org/10.1101/2024.05.21.589311",
"conditionsOfAccess": "Attribution is required to the copyright holders and the authors.",
"copyrightNotice": "Copyright (c) 2025 by The Regents of the University of California"
}