-
Notifications
You must be signed in to change notification settings - Fork 109
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
SIDECAR_KEY_REQUIRED not documented #2140
Comments
Hey @jens-k Thanks for the report. This metadata is also mentioned in the tables for the required metadata for EEG, ieeg and MEG. Though I admit those hits were at the bottom of the search when putting SoftwareFilters in the search bar of the bids specification. For the improvement of the error message I think you should probably reopen this issue in the repo of the bids validator. |
Will transfer the issue to the BIDS validator repo. |
I ran the BIDS validator on a super simple dataset (one subject, one session, just for testing) and got the error "SIDECAR_KEY_REQUIRED (SoftwareFilters)".
I cannot find any information about this issue. The validator provides a link but (as for any error or warning I have ever encountered), the content behind the link seems unrelated to my issue or too cryptic to make sense of it.
I therefore tried to look for "SIDECAR_KEY_REQUIRED" and "SIDECAR_KEY" (which is the type of error, so it should be way more common than the particular one I got about software filters) on the following websites:
I have no hits for any of the terms. As this seems to be an entirely undocumented requirement/tag/error, I thought this might be considered a bug. I found a cryptic description of "SoftwareFilters" here: https://bids-specification.readthedocs.io/en/stable/glossary.html#softwarefilters-metadata but a normal user cannot be expected to understand this schema, and it does not fit to how I solved the problem.
The answer the user should get is:
In the sidecar file "*****.json", we would have expected a key called "SoftwareFilters". This key is specific for the eeg datatype. You can fix the issue by adding another line
"SoftwareFilters": "anystringiguess",
to the json file.
Is there an effort to fix these error messages? If so, I'd be glad to contribute.
The text was updated successfully, but these errors were encountered: