dataset_schema.json

{
    "$id": "https://w3id.org/dats/schema/dataset_schema.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "DATS Dataset Schema",
    "description": "A set of dimensions about an entity being observed. A collection of data, published or curated by a single agent, and available for access or download in one or more formats (from DCAT: http://www.w3.org/TR/vocab-dcat/#Class:_Dataset). A body of structured information describing some topic(s) of interest (from: http://schema.org/Dataset).",
    "type": "object",
    "properties": {
        "@context": {
            "description": "The JSON-LD context",
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "object"
                },
                {
                    "type": "array"
                }
            ]
        },
        "@id": {
            "description": "The JSON-LD identifier",
            "type": "string", "format": "uri"
        },
        "@type": {
            "description": "The JSON-LD type",
            "type": "string",
            "const": "Dataset"
        },
        "identifier": {
            "description": "The identifier of the dataset.",
            "$ref": "identifier_info_schema.json#"
        },
        "alternateIdentifiers": {
            "description": "Alternate identifiers for the dataset.",
            "type": "array",
            "items": {
                "$ref": "alternate_identifier_info_schema.json#"
            }
        },
        "relatedIdentifiers": {
            "description": "Related identifiers for the dataset.",
            "type": "array",
            "items": {
                "$ref": "related_identifier_info_schema.json#"
            }
        },
        "title" : {
            "description" : "The name of the dataset, usually one sentence or short description of the dataset.",
            "type" : "string"
        },
        "description" : {
            "description": "A textual narrative comprised of one or more statements describing the dataset.",
            "type" : "string"
        },
        "dates" : {
            "description": "Relevant dates for the datasets, a date must be added, e.g. creation date or last modification date should be added.",
            "type" : "array",
            "items" : {
                "$ref" : "date_info_schema.json#"
            }
        },
        "storedIn" : {
            "description": "The data repository hosting the dataset.",
            "$ref": "data_repository_schema.json#"
        },
        "spatialCoverage": {
            "description": "The geographical extension and span covered by the dataset and its measured dimensions/variables.",
            "type" : "array",
            "items" : {
                "$ref" : "place_schema.json#"
            }
        },
        "types": {
            "description": "A term, ideally from a controlled terminology, identifying the dataset type or nature of the data, placing it in a typology",
            "type" : "array",
            "items" : {
                "$ref": "annotation_schema.json#"
            },
            "minItems" : 1
        },
        "availability": {
            "description": "A qualifier indicating the different types of availability for a dataset (available, unavailable, embargoed, available with restriction, information not available).",
            "type": "string"
        },
        "refinement": {
            "description": "A qualifier to describe the level of data processing of the dataset and its distributions.",
            "type": "string"
        },
        "aggregation": {
            "description": "A qualifier indicating if the entity represents an 'instance of dataset' or a 'collection of datasets'.",
            "type": "string"
        },
        "privacy": {
            "description": "A qualifier to describe the data protection applied to the dataset. This is relevant for clinical data.",
            "type": "string"
        },
        "distributions" : {
            "description": "The distribution(s) by which datasets are made available (for example: mySQL dump).",
            "type" : "array",
            "items" : {
                "$ref" : "dataset_distribution_schema.json#"
            }
        },
        "dimensions" : {
            "description": "The different dimensions (granular components)  making up a dataset.",
            "type" : "array",
            "items" : {
                "$ref" : "dimension_schema.json#"
            }
        },
        "primaryPublications" : {
            "description": "The primary publication(s) associated with the dataset, usually describing how the dataset was produced.",
            "type" : "array",
            "items" : {
                "$ref" : "publication_schema.json#"
            }
        },
        "citations" : {
            "description": "The publication(s) that cite this dataset.",
            "type" : "array",
            "items" : {
                "$ref" : "publication_schema.json#"
            }
        },
        "citationCount": {
            "description": "The number of publications that cite this dataset (consterated in the citations property)",
            "type": "integer"
        },
        "producedBy" : {
            "description": "A study process which generated a given dataset, if any.",
            "anyOf": [
                {"$ref" : "study_schema.json#"},
                {"$ref" : "data_acquisition_schema.json#"},
                {"$ref" : "data_analysis_schema.json#"}
            ]
        },
        "creators" : {
            "description": "The person(s) or organization(s) which contributed to the creation of the dataset.",
            "type" : "array",
            "items" : {
                "oneOf": [
                    {"$ref" : "person_schema.json#"},
                    {"$ref" : "organization_schema.json#"}
                ]
            },
            "minItems" : 1
        },
        "licenses": {
            "description": "The terms of use of the dataset.",
            "type": "array",
            "items": {
                "$ref": "license_schema.json#"
            }
        },
        "dataUseConditions": {
            "description": "Types of data use conditions extracted from the license documents. Data Use Conditions may refer to restrictions, prohibition, research topics as granted by the dataset, dimension, software license. Ideally specified from a controlled vocabulary or ontology, such as GA4GH Data Use Ontology (DUO: http://www.obofoundry.org/ontology/duo.html) or ADA-M matrix (https://github.com/ga4gh/ADA-M).",
            "type": "array",
            "items": {
                "oneOf": [
                    {"$ref" : "data_use_condition.json#"},
                    {"$ref" : "annotation_schema.json#"}
                ]
            }
        },
        "conformsTo" : {
            "description": "A data standard whose requirements and constraints are met by the dataset.",
            "type" : "array",
            "items" : {
            "$ref": "data_standard_schema.json#"
          }
        },
        "isAbout": {
            "description" : "Different entities (biological entity, taxonomic information, disease, molecular entity, anatomical part, treatment) associated with this dataset.",
            "type": "array",
            "items": {
                "anyOf": [
                    {"$ref" : "biological_entity_schema.json#"},
                    {"$ref" : "taxonomic_info_schema.json#"},
                    {"$ref" : "disease_schema.json#"},
                    {"$ref" : "molecular_entity_schema.json#"},
                    {"$ref" : "anatomical_part_schema.json#"},
                    {"$ref" : "treatment_schema.json#"},
                    {"$ref" : "material_schema.json#"},
                    {"$ref" : "study_group_schema.json#"},
                    {"$ref" : "category_values_pair_schema.json#"},
                    {"$ref" : "annotation_schema.json#"}
                ]
            }
        },
        "hasPart" : {
            "description": "A Dataset that is a subset of this Dataset; Datasets declaring the 'hasPart' relationship are considered a collection of Datasets, the aggregation criteria could be included in the 'description' field.",
            "type": "array",
            "items": {
                "$ref" : "dataset_schema.json#"
            }
        },
        "acknowledges" : {
            "description": "The grant(s) which funded and supported the work reported by the dataset.",
            "type" : "array",
            "items" : {
                "$ref" : "grant_schema.json#"
            }
        },
        "keywords" : {
            "description": "Tags associated with the dataset, which will help in its discovery.",
            "type": "array",
            "items": {
                "$ref" : "annotation_schema.json#"
            }
        },
        "version" : {
            "description": "A release point for the dataset when applicable.",
            "type" : "string"
        },
        "extraProperties": {
            "description": "Extra properties that do not fit in the previous specified attributes. ",
            "type": "array",
            "items": {
                "$ref" : "category_values_pair_schema.json#"
            }
        }
    },
    "additionalProperties": false,
    "required" : [ "title", "types", "creators" ]
}