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

Deprecate participant_label and exclude_participant_label args #262

Closed
pvandyken opened this issue Mar 13, 2023 · 4 comments
Closed

Deprecate participant_label and exclude_participant_label args #262

pvandyken opened this issue Mar 13, 2023 · 4 comments
Labels
blocked Feature currently blocked from being implemented deprecation Begin deprecation of an outdated feature

Comments

@pvandyken
Copy link
Contributor

Once we finish implementing the filtering apis #241, the participant_label and exclude_participant_label arguments on generate_inputs() become rather redundant. There would, at that point, be three separate ways to filter out subjects: BidsDatasets.filter(), the magic --filter-<component> args, and the generate_inputs() arguments. I think we can probably afford to simplify and deprecate.

@pvandyken pvandyken added the deprecation Begin deprecation of an outdated feature label Mar 13, 2023
@akhanf
Copy link
Member

akhanf commented Apr 15, 2023

If this would also deprecate the --participant_label cli arg, then that would be a deviation from bids-app standards, and it is a quite commonly used option in my experience. We could drop the exclude_participant_label perhaps.

@pvandyken
Copy link
Contributor Author

Ah, no definitely not talking about the cli. I was thinking more the arguments on the generate_inputs function

@tkkuehn
Copy link
Contributor

tkkuehn commented Jun 2, 2023

The CLI arg uses this so we should keep it for now, at least until BidsDataset.filter exists.

@tkkuehn tkkuehn added the wontfix This will not be worked on label Jun 2, 2023
@kaitj kaitj added blocked Feature currently blocked from being implemented and removed wontfix This will not be worked on labels Jun 2, 2023
@pvandyken
Copy link
Contributor Author

pvandyken commented Dec 13, 2023

As implemented in #344, these arguments actually do have distinct features: they apply filtering after paths are found via pybids, meaning you can end up with empty components as opposed to missing components. --participant-label also filters before running path parsing, meaning it's faster than running a filter after generate_inputs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked Feature currently blocked from being implemented deprecation Begin deprecation of an outdated feature
Projects
None yet
Development

No branches or pull requests

4 participants