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] schema for i/eeg coordsys+elecs: sub-ses-acq-space are allowed entities #743

Merged
merged 1 commit into from
Feb 25, 2021

Conversation

sappelhoff
Copy link
Member

@sappelhoff sappelhoff commented Feb 24, 2021

while opening bids-standard/bids-validator#1198 I noticed some inconsistencies in our schema.

Q&A about the changes in this PR.

  • Q: Why adding "space" to EEG coordsystem.json and "acq" to iEEG coordsystem.json?
    • A: coordsystem.json contains metadata for electrodes.tsv ... so it must support the same entities as electrodes.tsv
    • "space" is used to distinguish files from different "coordinate spaces"
    • "acq" is used for something like "coordinates digitized pre or post recording" -> acq-pre, acq-post
  • Q: Why allow electrodes.json?
    • A: that file explains additional arbitrary columns in electrodes.tsv ... these are not added to coordsystem.json, which has a restricted set of metadata that can/must be specified
  • And the remaining change is just for consistency, that space comes after acq in a file name.

I still have to rebuild the entitiy table, but I keep running into issues. @tsalo what's the current way to call the script (see also #696 )?

...:~/Desktop/bids/bids-specification$ python tools/schemacode/schema.py entities src/schema/ src/99-appendices/04-entity-table.md
Traceback (most recent call last):
File "tools/schemacode/schema.py", line 12, in
from . import utils

@tsalo
Copy link
Member

tsalo commented Feb 24, 2021

As of now, there is no command line integration for the schema functions. However, since we merged #610, you just need to render the specification locally, or check the CI, to check the updated entity table and filename patterns.

@sappelhoff
Copy link
Member Author

sappelhoff commented Feb 24, 2021

oh I completely forgot that this was removed in #610. I'll close #696 based on that. thanks.

This is ready for review/merging then.

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.

I checked the rendered filename patterns and the entity table, and it all looks good to me.

@sappelhoff sappelhoff merged commit 9cb5612 into bids-standard:master Feb 25, 2021
@sappelhoff
Copy link
Member Author

Thanks for the review Taylor and Adam!

@sappelhoff sappelhoff deleted the fixschema branch February 25, 2021 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

3 participants