A metadata model for stimulations; an openMINDS extension
The openMINDS_stimulation repository is part of the open Metadata Initiative for Neuroscience Data Structures (openMINDS). It extends openMINDS core, by providing schema-templates for adding detailed metadata specific to electrophysiology recordings to the neuroscience research products registered in the EBRAINS Knowledge Graph.
The major versions are developed and maintained in different version-branches. The default branch is always the latest version-branch. Each version can be accessed by checking out the corresponding version-branch. No major version branch has yet been released. This README describes the development branch ("main").
For more information on openMINDS in general and the processing pipelines for the schema-templates please go to the main repository: https://github.com/HumanBrainProject/openMINDS
The stimulation schemas are defined as JSON-schema inspired templates with only a few customized technical properties (prefixed with "_"). These simplified schema-templates are easy to read and can be robustly translated to other, well known target formats (e.g., HTML, JSON-schema, etc.).
In the schemas directory, all openMINDS_stimulation are defined in the openMINDS syntax (*.schema.tpl.json). Details about the openMINDS syntax can be found here.
In tests you can find JSON-LD documents designed to test the validation behaviour of each schema.
Each document follows the naming convention {schema_name}-{custom_test_name}.jsonld. For test cases supposed to fail the validation, the suffix -nok should be attached ({schema_name}-{custom_test_name}-nok.jsonld). The tests are validated every time a change is introduced and therefore ensure the correct behavior of the schemas.
In examples you will find several possible serializations of the openMINDS_stimulation metadata model. The scope of each example is described in its README. The correspondingly generated JSON-LD documents may be further structured (e.g., grouped according to the schema they are validated against).
Please check our contribution document.
This work is licensed under the MIT License.