[ENH] Clarify that electrodes.tsv are REQUIRED for iEEG data #1896
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1896 +/- ##
=======================================
Coverage 88.10% 88.10%
=======================================
Files 16 16
Lines 1396 1396
=======================================
Hits 1230 1230
Misses 166 166 ☔ View full report in Codecov by Sentry. |
This was referenced Aug 20, 2024
effigies
added
the
exclude-from-changelog
effigies
force-pushed
the
ieeg/require-electrodes
branch
from
377c777 to
bd6ee0e
Compare
effigies
force-pushed
the
ieeg/require-electrodes
branch
from
bd6ee0e to
d9a4e52
Compare
effigies
changed the title
effigies
added
iEEG
and removed
exclude-from-changelog
effigies
requested review from
dorahermes,
sappelhoff and
adam2392
and removed request for
erdalkaraca and
tsalo
sappelhoff
approved these changes
May 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The original iEEG spec intended electrodes.tsv to be REQUIRED, but the language was unintentionally softened during the inclusion in BIDS. This PR clarifies the language, and adds a validation rule to enforce the presence of electrodes.tsv files. Paired with bids-standard/bids-validator#207, this will support detecting multiple electrodes.tsv files that are distinguished by the
space-<label>entity.This PR also adds a check that each electrodes.tsv file has a corresponding coordsystem.json file. This was already enforced for optodes.tsv in NIRS datasets, but was missing for electrodes.tsv in *EG datasets.
This follows extensive discussion in bids-standard/bids-validator#206.
Closes #1854.