6.5 VRE Schema Description
Last modified by publicadmin on 2026/04/08 06:48
{under construction}
The VRE Schema is a collection of metadata schemas that describe a VRE Dataset. Before a Dataset can be created and saved, it must be annotated with a minimal set of metadata that can optionally be later used to register the Dataset in the VRE knowledge graph. For more information, see Annotations and Metadata Schemas
VRE Schema annotations can be provided in the VRE Portal Datasets graphical user interface (GUI). User provided annotations (key:value pairs) are stored in JSON file format and can be exported for reuse.
The following table describes the fields in the VRE Default Schema:
| VRE Schema Name | VRE Portal GUI field name | VRE Schema field name | Field Type | Constraints | Description | Required or Optional | Mapped element in DATS_core | Mapped element in openMINDS_core |
|---|---|---|---|---|---|---|---|---|
| Essential | Title | dataset_title | string | length <=100 characters | Name of the dataset. | REQUIRED for any dataset | ||
| Essential | Dataset Code | dataset_code | string | format: lowercase letter and/or number without whitespace, length <=32 characters | Platform-wise dataset unique ID. | REQUIRED for any dataset | ||
| Essential | Authors | dataset_authors | string, multiple entries | length <= 50 characters, maxItems: 10 | One or more authors of the dataset. | REQUIRED for any dataset | ||
| Essential | Type | dataset_type | checkbox, single select | selection in (GENERAL or BIDS) | Whether the Dataset type is GENERAL or BIDS. BIDS is selected for datasets that require use of the VRE BIDS validator tool. | OPTIONAL (if no selection, default is GENERAL) | ||
| Essential | Description | dataset_description | string | length <= 5000 characters | A textual narrative comprised of one or more statements describing the dataset | REQUIRED for any dataset | ||
| Essential | Modality | dataset_modality | dropdown, multi-select | selections in (anatomical approach, behavioral approach, cell counting, cell morphology, cell population, characterization, cell population imaging, computational modeling, electrophysiology, histological approach, microscopy, molecular expression approach, molecular expression characterization, morphological approach, multimodal approach, neural connectivity, neuroimaging, physiological approach) | One or several modalities represented in the dataset. | OPTIONAL | ||
| Essential | Collection Method | dataset_collection_method | string | length <= 20 characters maxItems: 10 | One or several collection methods of the dataset. | OPTIONAL | ||
| Essential | License | dataset_license | string | length <= 20 characters | The license under which this dataset is shared. The use of license name abbreviations is suggested for specifying a license. Please visit Creative Commons to choose the right license. | OPTIONAL | ||
| Essential | Tags | dataset_tags | string | length <= 20 characters maxItems: 10 format: | Tags associated with the dataset, which will help in its discovery. These should be well known terms by the research community. | OPTIONAL | ||
| Essential | Number of Subjects | dataset_subject_number | integer | integer | The number of subjects in the dataset. | OPTIONAL | ||
| Essential | Dataset Identifier | dataset_identifier | string | A code uniquely identifying the publication locally to a system or globally. Provide a Document Object Identifier (DOI) if have one. | OPTIONAL | |||
| Essential | Dataset Identifier Source | dataset_identifier_source | string | The identifier source represents information about the organisation/namespace responsible for minting the identifiers. | OPTIONAL | |||
| Essential | Derived From | dataset_derived_from | string | If the dataset is a derived dataset, name of the source dataset used to generate this dataset. The original dataset must also be included as a submodule in the derived dataset. | OPTIONAL | |||
| Essential | Parent Dataset Identifier | parent_dataset_identifier | string | Unique identifier of the source dataset used to generate this dataset. Provide a Document Object Identifier (DOI) if have one. | OPTIONAL | |||
| Essential | Parent Dataset Identifier Source | parent_dataset_identifier_source | string | The identifier source represents information about the organisation/ namespace responsible for minting the identifiers. | OPTIONAL | |||
| Essential | Related Publication Title | dataset_publication_title | string | The name of the publication of this dataset. | OPTIONAL | |||
| Essential | Related Publication Identifier | dataset_publication_identifier | string | A code uniquely identifying the publication locally to a system or globally. Provide a Document Object Identifier (DOI) if you have one. | OPTIONAL | |||
| Essential | Related Publication Identifier Source | dataset_publication_identifier_source | string | Information about the organisation/namespace responsible for minting the identifier. | OPTIONAL | |||
| Subjects | Subject ID | subject_id | string | The ID of the subject. | REQUIRED if schema is used | |||
| Subjects | Subject Sex | subject_sex | dropdown, single-select | selection in (Female, Male, Unknown, Other) | The sex of the subject. | REQUIRED if schema is used | ||
| Subjects | Subject Species | subject_species | dropdown, single-select | selection in (Homo sapiens, Macaca fascicularis, Macaca mulatta, Mus musculus, Mustela putorius, Rattus norvegicus, Other) | The species of the subject. | REQUIRED if schema is used | ||
| Subjects | Subject Age Category | subject_agecategory | dropdown, single-select | selection in (“Neonate, Infant, Juvenile, Young adult, Adult, Unknown, Other”) | The age category of the subject. | REQUIRED if schema is used | ||
| Disease | Disease Name | dataset_disease_name | string | The name of the disease. | REQUIRED if schema is used | |||
| Disease | Disease Diagnosis Date | daatset_disease_dates | string | format: date-time | Relevant dates, such as the diagnosis date of the disease, may be provided. | OPTIONAL | ||
| Disease | Disease Status | dataset_disease_status | string | A value (and ideally also an ontology annotation provided as a valueIRI) for the disease status. | OPTIONAL | |||
| Disease | Identifier | dataset_disease_identifier | string | A code uniquely identifying an entity locally to a system or globally. | OPTIONAL | |||
| Disease | Identifier Source | dataset_disease_identifier_source | string | The identifier source represents information about the organisation/namespace responsible for minting the identifiers. | OPTIONAL | |||
| Distribution | Dataset Distribution Technical Format | dataset_distribution_format | array of string | Technical format of dataset distribution, i.e., "NIfTI", "DICOM". | OPTIONAL | |||
| Distribution | Dataset Distribution Access Landing Page | dataset_distribution_landing_page | string | format: uri | Web address (URL) where the original dataset can be found. Default value points to the README.md for the dataset. | REQUIRED if schema is used | ||
| Distribution | Dataset Distribution Access Authorization | dataset_distribution_authorization | dropdown, single-select | selection in (“Public", "Registered" or "Private") | This must be one of "Public", "Registered" or "Private". When this field is absent the value will be treated as "Public". "Public" = available to anyone; "Registered" = available to user authorized by the creator; "Private" = available only to the creator. | OPTIONAL | ||
| Contributors | Contributor Type | dataset_contributors | array of string | selection in ("Person", "Organization") | One or more Persons or Organizations can be provided as the dataset's contributor(s). | REQUIRED if schema is used | ||
| Contributors | dataset_contributor_person_email , or dataset_contributor_organization_email | string | format: email | Email address of the contributor. | REQUIRED if schema is used | |||
| Contributors | Last Name | dataset_contributor_person_lastname , or dataset_contributor_organization_lastname | string | Last name of the contributor. | REQUIRED if schema is used | |||
| Contributors | First Name | dataset_contributor_person_firstname , or dataset_contributor_organization_firstname | string | First name of the contributor. | REQUIRED if schema is used |
Copyright © 2022, Indoc Research. This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.