Specification reference

ARC Datamap RO-Crate profile

Persistent identifier: https://w3id.org/arc/ro-crate/datamap/0.1

View this specification's source

#Overview

This profile is an instantiation of the Semantic Core profile, intended to represent the ARC datamap in the RO-Crate. The datamap contains contextual information for fragments within data files. Hence, these contextual information is represented as interpretations for the corresponding data entities.

To model data fragments, this profile extends the existing hierarchy at the bottom using the same mechanisms as in the normal RO-Crate data model: Data files are already referenced in their respective datasets through hasPart. Fragments are of type MediaObject (equivalent to File) and referenced by their parent file or fragment through hasPart.

Data Fragment Selector

We add the contextual information per entry in the datamap to the Dataset objects, conforming with the Semantic Core Profile. Accordingly, the fragments and their information then reference each other.

Datamap

See our peer-reviewed publication for more information on the datamap and its usage: Fragment-level FAIRness

#Detailed Description

We use MediaObject for data fragments and annotate them through descriptor objects for external metadata as described in the Semantic Core Profile. Both objects reference each other. The Dataset object lists all datamap entries. Specifically, we plan the following:

  • Each entry in the datamap becomes one entry in mentions of type PropertyValue.
  • Each data fragment becomes an object of type MediaObject, referenced from its file object through hasPart.
  • Each entry of the datamap becomes a semantic descriptor of type ItemList and Statement with an assertion in the form of a PropertyValue object.
  • The data fragments and their descriptors referennce each other through the about and subjectOf properties.
Diagram source
flowchart TD

dataset[Datamap=Dataset]

DataFile[Data=File]
DataFragment[DataFragment=MediaObject]

desc[DataContext=Statement/ItemList]
prop[Interpretation=PropertyValue]

DataFile --hasPart--> DataFragment
dataset --hasPart--> DataFile

DataFragment --subjectOf--> desc
desc --about--> DataFragment

dataset --mentions--> desc

desc --itemListElement--> prop

#Example Metadata File (ro-crate-metadata.json)

{
  "@context": [
    "https://w3id.org/ro/crate/1.2/context",
    {
      "Sample": "https://bioschemas.org/Sample",
      "LabProtocol": "https://bioschemas.org/LabProtocol",
      "LabProcess": "https://bioschemas.org/LabProcess",
      "computationalTool": "https://bioschemas.org/properties/computationalTool",
      "labEquipment": "https://bioschemas.org/properties/labEquipment",
      "reagent": "https://bioschemas.org/properties/reagent",
      "intendedUse": "https://bioschemas.org/properties/intendedUse",
      "executesLabProtocol": "https://bioschemas.org/properties/executesLabProtocol",
      "parameterValue": "https://bioschemas.org/properties/parameterValue",
      "columnIndex": "https://w3id.org/ro/terms/arc#columnIndex"
    }
  ],
  "@graph": [
    {
      "@id": "http://purl.obolibrary.org/obo/NCIT_C45253",
      "@type": "DefinedTerm",
      "name": "string",
      "termCode": "http://purl.obolibrary.org/obo/NCIT_C45253"
    },
    {
      "@id": "processed_data.csv#col=1",
      "@type": "File",
      "name": "processed_data.csv#col=1",
      "encodingFormat": "text/csv",
      "usageInfo": "https://datatracker.ietf.org/doc/html/rfc7111",
      "pattern": {
        "@id": "http://purl.obolibrary.org/obo/NCIT_C45253"
      },
      "subjectOf": {
        "@id": "#Descriptor_processed_data.csv#col=1"
      }
    },
    {
      "@id": "http://purl.obolibrary.org/obo/NCIT_C48150",
      "@type": "DefinedTerm",
      "name": "float",
      "termCode": "http://purl.obolibrary.org/obo/NCIT_C48150"
    },
    {
      "@id": "processed_data.csv#col=2",
      "@type": "File",
      "name": "processed_data.csv#col=2",
      "encodingFormat": "text/csv",
      "usageInfo": "https://datatracker.ietf.org/doc/html/rfc7111",
      "pattern": {
        "@id": "http://purl.obolibrary.org/obo/NCIT_C48150"
      },
      "subjectOf": {
        "@id": "#Descriptor_processed_data.csv#col=2"
      }
    },
    {
      "@id": "processed_data.csv#col=3",
      "@type": "File",
      "name": "processed_data.csv#col=3",
      "encodingFormat": "text/csv",
      "usageInfo": "https://datatracker.ietf.org/doc/html/rfc7111",
      "pattern": {
        "@id": "http://purl.obolibrary.org/obo/NCIT_C48150"
      },
      "subjectOf": {
        "@id": "#Descriptor_processed_data.csv#col=3"
      }
    },
    {
      "@id": "processed_data.csv",
      "@type": "File",
      "name": "processed_data.csv",
      "encodingFormat": "text/csv",
      "hasPart": [
        {
          "@id": "processed_data.csv#col=1"
        },
        {
          "@id": "processed_data.csv#col=2"
        },
        {
          "@id": "processed_data.csv#col=3"
        }
      ]
    },
    {
      "@id": "#Descriptor_processed_data.csv#col=1",
      "@type": [ "Statement", "ItemList" ],
      "about": {
        "@id": "processed_data.csv#col=1"
      },
      "itemListElement": [
        { "@id": "#Explication_processed_data.csv#col=1" }
      ]
    },
    {
      "@id": "#Descriptor_processed_data.csv#col=2",
      "@type": [ "Statement", "ItemList" ],
      "about": {
        "@id": "processed_data.csv#col=2"
      },
      "itemListElement": [
        { "@id": "#Explication_processed_data.csv#col=2" }
      ]
    },
    {
      "@id": "#Descriptor_processed_data.csv#col=3",
      "@type": [ "Statement", "ItemList" ],
      "about": {
        "@id": "processed_data.csv#col=3"
      },
      "itemListElement": [
        { "@id": "#Explication_processed_data.csv#col=3" }
      ]
    },
    {
      "@id": "#Explication_processed_data.csv#col=1",
      "@type": "PropertyValue",
      "name": "Explication",
      "value": "Protein identifier",
      "propertyID": "https://github.com/nfdi4plants/ARC-specification/blob/dev/ISA-XLSX.md#datamap-table-sheets",
      "valueReference": "http://purl.obolibrary.org/obo/NCIT_C165059",
      "alternateName": "protID"
    },
    {
      "@id": "#Explication_processed_data.csv#col=2",
      "@type": "PropertyValue",
      "name": "Explication",
      "value": "molecule count",
      "propertyID": "https://github.com/nfdi4plants/ARC-specification/blob/dev/ISA-XLSX.md#datamap-table-sheets",
      "unitCode": "http://purl.obolibrary.org/obo/NCIT_C68892",
      "unitText": "Millimole per Kilogram",
      "valueReference": "http://purl.obolibrary.org/obo/UO_0000192",
      "alternateName": "quant1"
    },
    {
      "@id": "#Explication_processed_data.csv#col=3",
      "@type": "PropertyValue",
      "name": "Explication",
      "value": "molecule count",
      "propertyID": "https://github.com/nfdi4plants/ARC-specification/blob/dev/ISA-XLSX.md#datamap-table-sheets",
      "unitCode": "http://purl.obolibrary.org/obo/NCIT_C68892",
      "unitText": "Millimole per Kilogram",
      "valueReference": "http://purl.obolibrary.org/obo/UO_0000192",
      "alternateName": "quant2"
    },
    {
      "@id": "LICENSE",
      "@type": "CreativeWork",
      "text": "ALL RIGHTS RESERVED BY THE AUTHORS"
    },
    {
      "@id": "./",
      "@type": "Dataset",
      "description": "An example of a ROCrate with a datamap, including annotation of a tabular data file.",
      "name": "ARC Datamap Crate Example",
      "hasPart": {
        "@id": "processed_data.csv"
      },
      "mentions": [
        {
          "@id": "#Descriptor_processed_data.csv#col=1"
        },
        {
          "@id": "#Descriptor_processed_data.csv#col=2"
        },
        {
          "@id": "#Descriptor_processed_data.csv#col=3"
        }
      ],
      "dateCreated": "2026-06-25T22:58:40.2416018",
      "license": {
        "@id": "LICENSE"
      }
    },
    {
      "@id": "ro-crate-metadata.json",
      "@type": "CreativeWork",
      "conformsTo": {
        "@id": "https://w3id.org/ro/crate/1.2"
      },
      "about": {
        "@id": "./"
      }
    }
  ]
}

#Requirements

#Dataset

Object containing and annotating data files and fragments. In the context of this profile, this object is used to represent the datamap and its entries.

PropertyRequiredExpected TypeDescription
@typeMUSTTextMust be 'schema.org/Dataset'
@idMUSTText or URLShould be a subdirectory corresponding to this dataset.
hasPartSHOULDFileThe data files resulting from the processes performed in this dataset.
mentionsCOULDText or schema.org/PropertyValueA fragment description entry from the datamap as a PropertyValue following the fragment description profile.

#Data (File)

Describes and points to a Data file.

PropertyRequiredExpected TypeDescription
@typeMUSTTextMust be 'File' or 'MediaObject'
@idMUSTText or URLShould be the path pointing to the file./
nameMUSTText or URLThe name of the file.
commentCOULDschema.org/CommentComment
encodingFormatCOULDText or URLMedia format as a MIME type
hasPartCOULDFileThe data fragments within this file. They must follow the Data Fragment profile.

#Data Fragment

Describes and points to a Fragment of a Data file. In addition to the filepath, the @id property must contain a fragment selector(separated by a #) to point to the specific fragment within the file. The specifcation describing the fragment selector should be provided in the usageInfo property.

PropertyRequiredExpected TypeDescription
@typeMUSTTextMust be 'File' or 'MediaObject'
@idMUSTText or URLShould be the path pointing to the file with a fragment selector attached.
usageInfoMUSTText or URL(Formal) Description of the fragment selector.
aboutSHOULDschema.org/PropertyValueThe fragment description for this fragment. It must follow the fragment description profile.
patternSHOULDschema.org/DefinedTermDefines the shape or format of entries in this fragment.
nameCOULDText or URLThe name of the file.
commentCOULDschema.org/CommentComment
encodingFormatCOULDText or URLMedia format as a MIME type

#Fragment Descriptor

Adds further annotation to a Data file or a Fragment thereof.

PropertyRequiredExpected TypeDescription
@typeMUSTTextMust be [schema.org/Statement, schema.org/ItemList]
@idMUSTText or URL
aboutMUSTschema.org/MediaObjectThe described data fragement using a fragment selector, following the data fragment profile.
itemListElementMUSTschema.org/PropertyValueThe assertion described in the datamap entry.

#Descriptor Assertion

The actual assertion of a datamap entry, describing the contents of a data fragment. It is represented as a PropertyValue object.

PropertyRequiredExpected TypeDescription
@typeMUSTTextMust be 'schema.org/PropertyValue'
@idMUSTText or URL
nameMUSTTextMust be "Explication"
propertyIDMUSTURLMUST be "https://purl.org/nfdi4plants/ontology/dpbo/DPBO_0000111"
valueSHOULDTextExplication of the data fragment contents
valueReferenceSHOULDURLValue ontology reference
unitTextSHOULDTextUnit of the data fragment
unitCodeSHOULDURLUnit ontology reference
alternateNameSHOULDTextThe label of the fragment, e.g. a column header.
measurementMethodSHOULDTextName of the tool used to create the data.
descriptionSHOULDTextCan be used to describe further details of the fragment