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

Make print_report in filtering functions False by default #343

Open
niksirbi opened this issue Nov 14, 2024 · 0 comments
Open

Make print_report in filtering functions False by default #343

niksirbi opened this issue Nov 14, 2024 · 0 comments
Labels
enhancement New optional feature

Comments

@niksirbi
Copy link
Member

Our filtering functions accept a print_report boolean argument, which is True by default.
When True, the function prints the percentage of NaNs for each keypoint, before and after the filter.
This is a very useful feature for seeing the effects of filtering on missing values, but it gets quite annoying when you have to do chain multiple filters or to loop a single filter over multiple datasets (as one would typically do in a preprocessing pipeline).
In such cases, the printed output grows quite fast and is very verbose.

Therefore I propose making the default value to be False. This functionality will be still documented in the examples, so people will be aware of its existence should they need it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New optional feature
Projects
Status: 🤔 Triage
Development

No branches or pull requests

1 participant