-
Notifications
You must be signed in to change notification settings - Fork 5
Labels
refactorSimplifying or restructuring existing code or documentation.Simplifying or restructuring existing code or documentation.usabilityIssue affecting user or developer experience.Issue affecting user or developer experience.
Description
Since:
- bids2table includes essentially every file suffix encountered in a BIDS dataset in the output
suffixcolumn, and - our
bids2tsvcommand looks at the difference between the bid2table-generatedsuffixcolumn and the Neurobagel-supported list of image file suffixes to identify "unrecognized" suffixes,
our warnings about unrecognized suffixes currently include non-imaging-related suffixes such as sessions and scans:
$ bagel bids2tsv -b tests/bids-examples/synthetic -f
[2025-11-26 13:32:34] INFO Input BIDS directory: D:\neurobagel\bagelbids\tests\bids-examples\synthetic
[2025-11-26 13:32:34] INFO BIDS validation passed.
[2025-11-26 13:32:34] WARNING Image file suffixes unsupported by Neurobagel were found in the BIDS directory: ['sessions', 'scans', 'beh', 'physio', 'stim']. These will be ignored. Supported BIDS suffixes: ['dwi', 'T1w',
'T2w', 'bold', 'asl', 'eeg', 'meg', 'pet'].
[2025-11-26 13:32:34] INFO Saved output to: D:\neurobagel\bagelbids\bids.tsvTo avoid unnecessarily verbose warnings (and raising alarm about irrelevant suffixes), we should see if we can:
- include only unrecognized imaging suffixes in the warning (maybe there is an importable version of this list https://bids-specification.readthedocs.io/en/stable/appendices/entity-table.html ?)
- note: https://github.com/bids-standard/bids-specification/blob/master/src/schema/objects/suffixes.yaml is not restrictive enough
- can use
bidsschematoolsto access these suffix lists
- first check: against all BIDS file suffixes (from
suffixes.yaml) and warn about any ones unrecognized (e.g., typos or custom) - second check: filter for BIDS raw file suffixes (https://github.com/bids-standard/bids-specification/tree/master/src/schema/rules/files/raw) and then check against Neurobagel-supported list; warn about unsupported suffixes
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
refactorSimplifying or restructuring existing code or documentation.Simplifying or restructuring existing code or documentation.usabilityIssue affecting user or developer experience.Issue affecting user or developer experience.
Type
Projects
Status
Review - Active