-
Notifications
You must be signed in to change notification settings - Fork 169
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] document required column order MEG, EEG, iEEG, PET, and fix typo iEEG #818
[FIX] document required column order MEG, EEG, iEEG, PET, and fix typo iEEG #818
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! lgtm
@sappelhoff sounds good to leave difference between iEEG/EEG&MEG for now, this already makes things much clearer. |
Thanks for implementing this @sappelhoff Had no idea some TSV even have required column orders: any other tables with that required fetaure? |
yes 🤔 good point, blood.tsv wants "time" in the first column: But it's not described in the spec as far as I can see? Did I oversee a note that If it's not there, do we want to:
|
Yes - when implementing the validator we wanted to have "time" as the first column to impose a certain structure. I would suggest to add a note to the spec on this when introducing the columns for the blood data. It could be something like this: "The following columns are defined for _blood.tsv files, and the |
bd100a3
to
c1c3d89
Compare
Thanks @mnoergaard , I added a note. Please add an approving review if you think this is fine. |
LGTM, thanks @sappelhoff! |
closes #817
The EEG and iEEG specs had sentences like "columns X, Y, ... are required" before the table outlining the requirement levels. For the iEEG spec, this was furthermore inconsistent.
I removed these sentences before the tables as duplicate information, thereby also fixing the ieeg inconsistency.
I furthermore added a note to the tables where the order column is mandatory. This was not documented consistently before, and many people probably only found out about this by getting the validator error that is generated by these lines:
https://github.com/bids-standard/bids-validator/blob/c60daacf3dbb4cea5a07d5274947c366cf4c0e3a/bids-validator/validators/tsv/tsv.js#L243-L298
@dorahermes I saw your comment voting for making the column order of ieeg files consistent with those of EEG and MEG (only name, type, units, instead of additionally low and high cutoff). But that'd be a more invasive change that I don't think is necessary at this point (no complaints or issues have been raised about this). Let me know if you think otherwise.