NOTE: This repository is a work in progress.
The recommended way to view this repository and templates is through the hosted GitHub pages at https://in2primatebrains.github.io/CommonLocalizerMetadataTemplates/
Common localizers are a set of standardized tasks and conditions performed by In2PB labs, generating recordings that can be aggregated and compared, across different brain regions and with different recording modalities.
This repository contains metadata templates to be used to describe the data generated by these localizer protocols.
There are metadata templates for the following types of data:
| Category | OpenView | CEDAR JSON | odML | Create instance using CEDAR Workbench |
|---|---|---|---|---|
| Dataset Description | OpenView | CEDAR JSON | odML | Create instance |
| Subject | OpenView | CEDAR JSON | odML | Create instance |
| Session and Trials | OpenView | CEDAR JSON | odML | Create instance |
| Task and Events | OpenView | CEDAR JSON | odML | Create instance |
| Electrophysiology | OpenView | CEDAR JSON | odML | Create instance |
| Eye Tracking | OpenView | CEDAR JSON | odML | Create instance |
| Video Recording | OpenView | CEDAR JSON | odML | Create instance |
- Cedar Workbench Orientation
- Filling out metadata templates
If you are part of the In2PB consortium, you can use the dedicated CEDAR Workbench In2PrimateBrains account to create metadata instances.
Please contact reema.gupta[@]lmu.de to recieve the credentials for this account.
Once you have the credentials, please refer to the repo on either GIN or GitHub for detailed instructions. Note that the linked repositories are private and only accessible to In2PB organization members on either platform.
- odML Python API - The odML Python API is a library to work with odML templates and documents in Python.
- Tutorials on using odML - The tutorials here provide an overview of the odML data model and how to use the odML Python API to create, manipulate, and save odML documents.
- odMLtables - odML tables is a tool for interfacing with odML documents in a tabular format. You can use the CSV templates in this repository to create odML documents using odMLtables.
- More information on odML data model
The metadata templates are also available in other formats such as a CSV, simple JSON, and YAML. Note that these formats are bare representations of the metadata templates and do not contain all attributes related to the metadata fields that are present in the CEDAR JSON format. Please write to us if you intend to use these formats.
If you have any feedback or suggestions for the metadata templates, please create an issue in this repository or contact reema.gupta[@]lmu.de.