API ReferenceProduct Documentation
Product Documentation

Add Ontology and Descriptions to IDS

Suggest Edits

An Intermediate Data Schema (IDS) can be easily extended with a description or ontology of your choice.

Each IDS is designed in collaboration with instrument manufacturers and life sciences companies. Their design is also influenced by Allotrope Foundation.

You can add optional fields (such as @type and @id) in the IDS to encode Linked Data. TetraScience uses an ADF Converter application to convert the IDS JSON file into an HDF5-based ADF file by using the Leaf Node pattern.

Example IDS That Includes an Added Ontology and Description

The following is an example IDS that includes added @id, @type, and @prefLabel fields:

{
  "type": "object",
  "properties": {
    "@idsType": {
      "type": "string",
      "const": "lc-column"
    },
    "@idsVersion": {
      "type": "string",
      "const": "v1.0.0"
    },
    "@idsNamespace": {
      "type": "string",
      "const": "common"
    },
    "column": {
      "type": "object",
      "properties": {
        "id": {
            "type": "string",
            "description": "Unique identifier of a separation column used in liquid chromatography",
            "@type": "http://purl.company.org/column#lc-0000",
            "@prefLabel": "Column ID"            
        },
        "target_temperature": {
          "type": "object",
          "description": "Target temperature of liquid chromatography column during an injection, unit in Degree Celsius",
          "@type": "http://purl.company.org/column#lc-0001",
          "@prefLabel": "Column Target Temperature",
          "properties": {
              "value": {
                  "type": "number"
              },
              "unit": {
                  "type": "string",
                  "const": "DegreeCelsius",
                  "@prefLabel": "Degree Celsius",
                  "@id": "http://qudt.org/vocab/unit#DegreeCelsius"
              }
          }
       }
      }
    }
  }
}

Documentation Feedback

Do you have questions about our documentation or suggestions for how we can improve it? Start a discussion in TetraConnect Hub. For access, see Access the TetraConnect Hub.

📘

NOTE

Feedback isn't part of the official TetraScience product documentation. TetraScience doesn't warrant or make any guarantees about the feedback provided, including its accuracy, relevance, or reliability. All feedback is subject to the terms set forth in the TetraConnect Hub Community Guidelines.

Updated 19 days ago