Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MED example dataset (no data, only headers) #469

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

MEDFormat
Copy link

@MEDFormat MEDFormat commented Oct 17, 2024

@Remi-Gau
Copy link
Contributor

@MEDFormat you will have to rename the folders to comply with the BIDS data strcuture.

@MEDFormat
Copy link
Author

MEDFormat commented Oct 18, 2024 via email

@Remi-Gau
Copy link
Contributor

please check any of the other iEEG datasets in this repo and see how the files are named and try top match this.

for example

tree ../examples/ieeg_epilepsy 
../examples/ieeg_epilepsy
├── CHANGES
├── dataset_description.json
├── derivatives
├── participants.json
├── participants.tsv
├── README
└── sub-01
    ├── ses-postimp
    │   ├── anat
    │   │   └── sub-01_ses-postimp_T1w.nii.gz
    │   ├── ieeg
    │   │   ├── sub-01_ses-postimp_space-IXI549Space_coordsystem.json
    │   │   ├── sub-01_ses-postimp_space-IXI549Space_electrodes.tsv
    │   │   ├── sub-01_ses-postimp_space-ScanRAS_coordsystem.json
    │   │   ├── sub-01_ses-postimp_space-ScanRAS_electrodes.tsv
    │   │   ├── sub-01_ses-postimp_task-seizure_run-01_channels.tsv
    │   │   ├── sub-01_ses-postimp_task-seizure_run-01_events.tsv
    │   │   ├── sub-01_ses-postimp_task-seizure_run-01_ieeg.eeg
    │   │   ├── sub-01_ses-postimp_task-seizure_run-01_ieeg.json
    │   │   ├── sub-01_ses-postimp_task-seizure_run-01_ieeg.vhdr
    │   │   ├── sub-01_ses-postimp_task-seizure_run-01_ieeg.vmrk
    │   │   ├── sub-01_ses-postimp_task-seizure_run-02_channels.tsv
    │   │   ├── sub-01_ses-postimp_task-seizure_run-02_events.tsv
    │   │   ├── sub-01_ses-postimp_task-seizure_run-02_ieeg.eeg
    │   │   ├── sub-01_ses-postimp_task-seizure_run-02_ieeg.json
    │   │   ├── sub-01_ses-postimp_task-seizure_run-02_ieeg.vhdr
    │   │   ├── sub-01_ses-postimp_task-seizure_run-02_ieeg.vmrk
    │   │   ├── sub-01_ses-postimp_task-seizure_run-03_channels.tsv
    │   │   ├── sub-01_ses-postimp_task-seizure_run-03_events.tsv
    │   │   ├── sub-01_ses-postimp_task-seizure_run-03_ieeg.eeg
    │   │   ├── sub-01_ses-postimp_task-seizure_run-03_ieeg.json
    │   │   ├── sub-01_ses-postimp_task-seizure_run-03_ieeg.vhdr
    │   │   └── sub-01_ses-postimp_task-seizure_run-03_ieeg.vmrk
    │   └── sub-01_ses-postimp_scans.tsv
    └── ses-preimp
        ├── anat
        │   ├── sub-01_ses-preimp_T1w.json
        │   └── sub-01_ses-preimp_T1w.nii.gz
        └── sub-01_ses-preimp_scans.tsv

Given that MED has files listed under a folder I think you may have to follow what is done with MEG for meg.ds

tree ../examples/ds000246 
../examples/ds000246
├── CHANGES
├── dataset_description.json
├── participants.json
├── participants.tsv
├── README
├── sub-0001
│   ├── anat
│   │   └── sub-0001_T1w.nii.gz
│   ├── meg
│   │   ├── sub-0001_acq-LPA_photo.jpg
│   │   ├── sub-0001_acq-NAS_photo.jpg
│   │   ├── sub-0001_acq-RPA_photo.jpg
│   │   ├── sub-0001_coordsystem.json
│   │   ├── sub-0001_headshape.pos
│   │   ├── sub-0001_task-AEF_run-01_channels.tsv
│   │   ├── sub-0001_task-AEF_run-01_meg.ds
│   │   │   ├── BadChannels
│   │   │   ├── ChannelGroupSet.cfg
│   │   │   ├── ClassFile.cls
│   │   │   ├── MarkerFile.mrk
│   │   │   ├── sub-0001_task-AEF_run-01_meg.acq
│   │   │   ├── sub-0001_task-AEF_run-01_meg.eeg
│   │   │   ├── sub-0001_task-AEF_run-01_meg.hc
│   │   │   ├── sub-0001_task-AEF_run-01_meg.hist
│   │   │   ├── sub-0001_task-AEF_run-01_meg.infods
│   │   │   ├── sub-0001_task-AEF_run-01_meg.meg4
│   │   │   └── sub-0001_task-AEF_run-01_meg.res4
│   │   ├── sub-0001_task-AEF_run-01_meg.json
│   │   ├── sub-0001_task-AEF_run-02_channels.tsv
│   │   ├── sub-0001_task-AEF_run-02_meg.ds
│   │   │   ├── BadChannels
│   │   │   ├── ChannelGroupSet.cfg
│   │   │   ├── ClassFile.cls
│   │   │   ├── MarkerFile.mrk
│   │   │   ├── sub-0001_task-AEF_run-02_meg.acq
│   │   │   ├── sub-0001_task-AEF_run-02_meg.eeg
│   │   │   ├── sub-0001_task-AEF_run-02_meg.hc
│   │   │   ├── sub-0001_task-AEF_run-02_meg.hist
│   │   │   ├── sub-0001_task-AEF_run-02_meg.infods
│   │   │   ├── sub-0001_task-AEF_run-02_meg.meg4
│   │   │   ├── sub-0001_task-AEF_run-02_meg.newds
│   │   │   └── sub-0001_task-AEF_run-02_meg.res4
│   │   └── sub-0001_task-AEF_run-02_meg.json
│   └── sub-0001_scans.tsv
└── sub-emptyroom
    ├── meg
    │   ├── sub-emptyroom_task-noise_run-01_channels.tsv
    │   ├── sub-emptyroom_task-noise_run-01_meg.ds
    │   │   ├── BadChannels
    │   │   ├── ClassFile.cls
    │   │   ├── default.de
    │   │   ├── params.dsc
    │   │   ├── processing.cfg
    │   │   ├── sub-emptyroom_task-noise_run-01_meg.acq
    │   │   ├── sub-emptyroom_task-noise_run-01_meg.hc
    │   │   ├── sub-emptyroom_task-noise_run-01_meg.hist
    │   │   ├── sub-emptyroom_task-noise_run-01_meg.infods
    │   │   ├── sub-emptyroom_task-noise_run-01_meg.meg4
    │   │   ├── sub-emptyroom_task-noise_run-01_meg.newds
    │   │   └── sub-emptyroom_task-noise_run-01_meg.res4
    │   └── sub-emptyroom_task-noise_run-01_meg.json
    └── sub-emptyroom_scans.tsv

@MEDFormat
Copy link
Author

Can you point me to the MEF 3.0 example? I cannot find it, but MED will be almost identical.

@MEDFormat
Copy link
Author

MEDFormat commented Oct 18, 2024 via email

@MEDFormat
Copy link
Author

Copy paste error above:
"vid_0001_s0001.vidx" video metadata
should have been:
"vid_0001_s0001.vmet" video metadata

@Remi-Gau
Copy link
Contributor

Can you point me to the MEF 3.0 example?

AFAICT we do not have one

@MEDFormat
Copy link
Author

MEDFormat commented Oct 18, 2024 via email

@MEDFormat
Copy link
Author

MEDFormat commented Oct 18, 2024 via email

@Remi-Gau
Copy link
Contributor

I think your dataset should be structured like this

├── dataset_description.json
├── README.md
└── sub-01
    └── sub-01_task-TaskName_ieeg.medd

where sub-01_task-TaskName_ieeg.medd is actually the test.medd from above.

@Remi-Gau
Copy link
Contributor

@effigies
Copy link
Contributor

@MEDFormat @Remi-Gau I've copied a pared down version of ieeg_epilepsy and replaced the _ieeg.* files with an _ieeg.medd directory and pushed to this PR.

Making some additional changes to adjust validator behavior, given that we aren't targeting the legacy validator and the schema changes havn't been merged yet.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe we should mention in the README that this dataset was mostly copied and adapted from another example: in case someone is looking for the 'real' BIDS dataset for this, otherwise they may think that we already have one that exist in the wild that they could have a look at.

"Name": "Brainstorm epileptogenicity tutorial",
"BIDSVersion": "1.7.0",
"License": "This tutorial dataset (EEG and MRI data) remains property of the Grenoble University Hospital, France. Its use and transfer outside the ImaGIN tutorial, e.g. for research purposes, is prohibited without written consent. For questions, please contact Olivier David, PhD ([email protected]).",
"Authors": [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would also make sense to update the readme because of all the authors and institutions metadata: these people may otherwise wonder what dataset of theirs this one is linked to

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

feels easier than cleaning up all the dataset of any reference of the dataset it was copied from

Copy link
Contributor

@effigies effigies left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Remi-Gau WDYT?

.github/workflows/validate_datasets.yml Outdated Show resolved Hide resolved
Comment on lines +1 to +4
Dataset description
===================

Example dataset demonstrating the [MED Format](https://medformat.org)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Dataset description
===================
Example dataset demonstrating the [MED Format](https://medformat.org)
MED Format demonstration
========================
Example dataset demonstrating the [MED Format](https://medformat.org).
This dataset is a copy of the [ieeg_epilepsy](../ieeg_epilepsy) example's raw data (run 1 only), replacing the BrainVision files with a `.medd/` directory.

Comment on lines +2 to +19
"Name": "Brainstorm epileptogenicity tutorial",
"BIDSVersion": "1.7.0",
"License": "This tutorial dataset (EEG and MRI data) remains property of the Grenoble University Hospital, France. Its use and transfer outside the ImaGIN tutorial, e.g. for research purposes, is prohibited without written consent. For questions, please contact Olivier David, PhD ([email protected]).",
"Authors": [
"Olivier David",
"Thomas Blauwblomme",
"Anne-Sophie Job",
"Stephan Chabardès",
"Dominique Hoffmann",
"Lorella Minotti",
"Philippe Kahane"
],
"ReferencesAndLinks": [
"David O, Blauwblomme T, Job AS, Chabardès S, Hoffmann D, Minotti L, Kahane P, Imaging the seizure onset zone with stereo-electroencephalography, Brain. 2011 Oct;134(10):2898-911",
"Lamarche F, Job AS, Deman P, Bhattacharjee M, Hoffmann D, Gallazzini-Crépin C, Bouvard S, Minotti L, Kahane P, David O, Correlation of FDG-PET hypometabolism and SEEG epileptogenicity mapping in patients with drug-resistant focal epilepsy, Epilepsia. 2016 Dec; 57(12):2045–2055",
"https://neuroimage.usc.edu/brainstorm/Tutorials/Epileptogenicity",
"https://f-tract.eu/tutorials/"
]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"Name": "Brainstorm epileptogenicity tutorial",
"BIDSVersion": "1.7.0",
"License": "This tutorial dataset (EEG and MRI data) remains property of the Grenoble University Hospital, France. Its use and transfer outside the ImaGIN tutorial, e.g. for research purposes, is prohibited without written consent. For questions, please contact Olivier David, PhD ([email protected]).",
"Authors": [
"Olivier David",
"Thomas Blauwblomme",
"Anne-Sophie Job",
"Stephan Chabardès",
"Dominique Hoffmann",
"Lorella Minotti",
"Philippe Kahane"
],
"ReferencesAndLinks": [
"David O, Blauwblomme T, Job AS, Chabardès S, Hoffmann D, Minotti L, Kahane P, Imaging the seizure onset zone with stereo-electroencephalography, Brain. 2011 Oct;134(10):2898-911",
"Lamarche F, Job AS, Deman P, Bhattacharjee M, Hoffmann D, Gallazzini-Crépin C, Bouvard S, Minotti L, Kahane P, David O, Correlation of FDG-PET hypometabolism and SEEG epileptogenicity mapping in patients with drug-resistant focal epilepsy, Epilepsia. 2016 Dec; 57(12):2045–2055",
"https://neuroimage.usc.edu/brainstorm/Tutorials/Epileptogenicity",
"https://f-tract.eu/tutorials/"
]
"Name": "MED Format example",
"BIDSVersion": "1.10.0",
"License": "CC0",
"Authors": [
"BIDS Contributors"
],
"ReferencesAndLinks": [
"../ieeg_epilepsy",
"https://medformat.org/"
]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants