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

[FIX] Permitting desc for channels and events #2043

Merged

Conversation

neuromechanist
Copy link
Member

Fixes #2029, to accommodate the desc entity (based on the current derivative specifications, for channels, electrodes, coordsystem and events files.

I was not sure if adding description to channels.channel would be inherited to other special cases, such as channels.channels__motion, so I explicitly included those in the schema as well.

@effigies, I appreciate your insights.

@neuromechanist
Copy link
Member Author

cc: @arnodelorme

Copy link
Collaborator

@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.

This looks reasonable to me. I pushed a fix that I hope resolves the CI, but we'll see.

It seems raw electrodes files already support space, but should derivative coordsystems? I ask purely out of ignorance; if the answer is no, I'm happy to defer to those who use these data.

@neuromechanist
Copy link
Member Author

Thanks, and sorry for the oversight.

The EEG specifications does allow space, although does not describe space at all, nor there are examples for it.

iEEG provides a use (and examples) for space, specifying which "space" (that is coordinate system) the sensors/electrodes are placed in, for instance, MNI, Talairach, etc. With this use, space should be available for both electrodes and coordsystem as a raw entity. I can see that some people may change the space to a more "convenient one" for their use during processing and share the data in a new space as a derivative, but, that use case already will have a change in the space label as well as hopefully a description. I am not sure if this answers your question.

@effigies effigies changed the base branch from master to maint/1.10.0 February 5, 2025 20:47
Copy link
Member

@tsalo tsalo left a comment

Choose a reason for hiding this comment

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

The changes make sense to me

@effigies
Copy link
Collaborator

effigies commented Feb 5, 2025

Since this is a fix to the schema and not something new to BIDS, this targets the maint/1.10.0 branch. We will make a new schema release.

@effigies effigies merged commit 88f3e14 into bids-standard:maint/1.10.0 Feb 5, 2025
17 of 18 checks passed
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.

[BUG] channels and events files do not accept desc for derivative datastest
3 participants