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.

Sign up for GitHub

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

Jump to bottom

[FIX] Clarify that electrodes.tsv is optional for MEG, for use with simultaneous (i)EEG #1555

Merged
merged 4 commits into from
Aug 24, 2023
Merged

[FIX] Clarify that electrodes.tsv is optional for MEG, for use with simultaneous (i)EEG #1555

merged 4 commits into from
Aug 24, 2023

Conversation

effigies
Copy link
Collaborator

Fixes #1550.

@effigies effigies added MEG Magnetoencephalography EEG Electroencephalography schema Issues related to the YAML schema representation of the specification. Patch version release. labels Jul 14, 2023
@effigies effigies mentioned this pull request Jul 14, 2023
Closed
@codecov
Copy link

codecov bot commented Jul 14, 2023 •
edited
Loading

Codecov Report

Patch and project coverage have no change.

Comparison is base (334dd36) 87.83% compared to head (2facc67) 87.83%.
Report is 31 commits behind head on master.

❗ Current head 2facc67 differs from pull request most recent head 3772352. Consider uploading reports for the commit 3772352 to get more accurate results

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #1555   +/-   ##
=======================================
  Coverage   87.83%   87.83%           
=======================================
  Files          16       16           
  Lines        1356     1356           
=======================================
  Hits         1191     1191           
  Misses        165      165

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

robertoostenveld
robertoostenveld approved these changes Jul 14, 2023
View reviewed changes
Copy link
Collaborator

@robertoostenveld robertoostenveld left a comment

Choose a reason for hiding this comment

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

I approve.

@effigies effigies mentioned this pull request Jul 14, 2023
Merged
@robertoostenveld robertoostenveld mentioned this pull request Jul 17, 2023
Open
sappelhoff
sappelhoff reviewed Jul 20, 2023
View reviewed changes
Copy link
Member

@sappelhoff sappelhoff left a comment

Choose a reason for hiding this comment

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

Thanks @effigies!

Let's wait for further discussion based on my comment in:

sappelhoff
sappelhoff requested changes Jul 20, 2023
View reviewed changes
Copy link
Member

@sappelhoff sappelhoff left a comment

Choose a reason for hiding this comment

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

(placing this here as a visual block, as this is not yet ready IMHO)

sappelhoff
sappelhoff reviewed Aug 21, 2023
View reviewed changes
Copy link
Member

@sappelhoff sappelhoff left a comment

Choose a reason for hiding this comment

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

What do you think about this?

perhaps we should add a section about electrodes.tsv to the MEG section of the BIDS specification, and make corresponding schema adjustments.

I see that you have opted for not adding a new section and instead adding this information under Recording EEG simultaneously with MEG. I think I'd be fine with that as well.

src/schema/rules/checks/meg.yaml Outdated
@@ -0,0 +1,14 @@
# Rules for MEG data that cannot be defined in tables
---
MEGElectrodesRecommended:
Copy link
Member

Choose a reason for hiding this comment

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

as outlined in #1550 (comment), I think this should be optional --> this electrode information can also be stored in _headshape.<ext> files or sometimes in the data file format itself (Elekta/Neuromag/MEGIN).

src/modality-specific-files/magnetoencephalography.md Show resolved Hide resolved
src/modality-specific-files/magnetoencephalography.md Outdated
@@ -98,8 +98,10 @@ it SHOULD be stored separately under a new `/eeg` data type
If however EEG is recorded simultaneously **with the same MEG system**,
it MAY be stored under the `/meg` data type.
In that case, it SHOULD have the same sampling frequency as MEG (see `SamplingFrequency` field below).
Furthermore, the EEG sensor coordinates SHOULD be specified using MEG-specific coordinate
systems (see [coordinates section](#coordinate-system-json-_coordsystemjson) below and
Furthermore, EEG sensor coordinates SHOULD be recorded in an
Copy link
Member

Choose a reason for hiding this comment

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

IMHO the SHOULD should become a MAY.

So far, the spec allowed for recording electrode positions in the _headshape: https://bids-specification.readthedocs.io/en/stable/glossary.html#headshape-suffixes

@effigies effigies changed the title [FIX] Clarify that electrodes.tsv is recommended for simultaneous MEG/EEG [FIX] Clarify that electrodes.tsv is optional for MEG, for use with simultaneous (i)EEG Aug 24, 2023
@effigies effigies merged commit 02d97b0 into bids-standard:master Aug 24, 2023
16 checks passed
@effigies effigies deleted the fix/meg_electrodes branch August 24, 2023 18:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sappelhoff sappelhoff sappelhoff approved these changes

@robertoostenveld robertoostenveld robertoostenveld approved these changes

@tsalo tsalo Awaiting requested review from tsalo

@erdalkaraca erdalkaraca Awaiting requested review from erdalkaraca erdalkaraca is a code owner

Assignees
No one assigned
Labels
EEG Electroencephalography MEG Magnetoencephalography schema Issues related to the YAML schema representation of the specification. Patch version release.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

electrodes.tsv for simultaneous MEG/EEG data
3 participants
@effigies @robertoostenveld @sappelhoff