search

lina-usc / pylossless

🧠 EEG Processing pipeline that annotates continuous data
https://pylossless.readthedocs.io/en/latest/
MIT License
24 stars 8 forks source link

Utilize `desc` BIDS entity #171

Open scott-huberty opened 1 week ago

scott-huberty commented 1 week ago

BIDS/MNE-BIDS allows you to specify a desc entity for derivatives data, to provide some description of the data.

Utilizing this would allow us to add desc-pylossless or desc-ica to the filename, instead of doing:

ica_bidspath = bpath.update(extension=".fif", suffix='_ica', check=False)

Where we force a Non BIDS-compliant suffix.

However this technically will be API breaking so might require some discussion and extra communication to users.

christian-oreilly commented 5 days ago

We could probably support both naming conventions on "read" to avoid breaking people's stuff while emitting a deprecation warning for people still reading files with the extension. I am not sure it has to break the API...

scott-huberty commented 5 days ago

We could probably support both naming conventions on "read" to avoid breaking people's stuff while emitting a deprecation warning for people still reading files with the extension. I am not sure it has to break the API...

I like your style!