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

[SCHEMA] Add derivatives entities to the schema #645

Merged
merged 4 commits into from
Nov 19, 2020

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented Oct 16, 2020

This stems from mne-tools/mne-bids#449 (comment).

Changes proposed:

  • Add the derivatives entities (res, den, label, and desc) to the schema.
  • Redefine the space entity so it works for EEG/MEG/iEEG and MRI data.
  • Generate the updated Entities page.

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.

Looks reasonable. I've added a little bit of extra content so they don't look quite so bare.

src/schema/entities.yaml Outdated Show resolved Hide resolved
src/schema/entities.yaml Show resolved Hide resolved
src/schema/entities.yaml Show resolved Hide resolved
Co-authored-by: Chris Markiewicz <effigies@gmail.com>
@adam2392
Copy link
Member

Is it possible to enumerate which ones are referred to as source_entities and then which entities are reserved for derivatives? So I would imagine a list of supported raw/source entities and then a running list of derivative entities?

E.g. desc from what I understand is only meant for derivatives, so it should never be present in a BIDS source dataset

@tsalo
Copy link
Member Author

tsalo commented Oct 23, 2020

@adam2392 We could add a field to the schema that describes scope, but I think that could quickly become confusing (e.g., space is raw for MEG/EEG/iEEG but derivatives-only for MRI). Would it be enough if I expanded the descriptions to clarify that they can only be used with Derivatives data?

@adam2392
Copy link
Member

@adam2392 We could add a field to the schema that describes scope, but I think that could quickly become confusing (e.g., space is raw for MEG/EEG/iEEG but derivatives-only for MRI). Would it be enough if I expanded the descriptions to clarify that they can only be used with Derivatives data?

Oh okay yeah that sounds good! I suppose that's a pretty simple fix for now and makes sense given what you said. Is desc the only Derivatives-only entity?

@sappelhoff
Copy link
Member

@tsalo @effigies unless you have final issues with this, I think one of you can merge this.

@effigies effigies merged commit f2545fe into bids-standard:master Nov 19, 2020
@tsalo tsalo deleted the enh/schema-derivatives branch November 20, 2020 18:39
@tsalo tsalo added the schema Issues related to the YAML schema representation of the specification. Patch version release. label Apr 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
schema Issues related to the YAML schema representation of the specification. Patch version release.
Projects
Development

Successfully merging this pull request may close these issues.

4 participants