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

ENH: BIDS filters and support *plugins* (incl. a rating widget as the example) #62

Merged
merged 2 commits into from
Mar 23, 2023

Conversation

oesteban
Copy link
Member

@oesteban oesteban commented Mar 21, 2023

This PR

  • Add support for BIDS filters
  • Add the concept of plugins -- First used with MRIQC's rating widget.

Plugins

  • They must have a YAML-formatted bootstrap file (akin to the main bootstrap file of the report)
  • They can be loaded as an argument (passed as a dictionary pointing at the bootstrap file resource) or in the main bootstrap file.
  • They accept metadata for further configuration.

Summary

In principle, with this PR we should be ready to generate MRIQC reports.

Finalizes: nipreps/mriqc#57.

@oesteban oesteban force-pushed the enh/57-rating-widget branch 4 times, most recently from 1d89dd9 to 0076690 Compare March 23, 2023 10:36
@oesteban oesteban force-pushed the enh/57-rating-widget branch from 0076690 to 65d9648 Compare March 23, 2023 10:37
@oesteban oesteban marked this pull request as ready for review March 23, 2023 15:48
@oesteban oesteban changed the title ENH: Add plugins to the report specification (adding a rating widget) ENH: BIDS filters and support *plugins* (incl. a rating widget as the example) Mar 23, 2023
Comment on lines +34 to +47
head-motion: Head motion artifacts
eye-spillover: Eye spillover through <abbr title="phase-encoding">PE</abbr> axis
noneye-spillover: Non-eye spillover through <abbr title="phase-encoding">PE</abbr> axis
coil-failure: Coil failure
noise-global: Global noise
noise-local: Local noise
em-perturbation: <abbr title="electromagnetic">EM</abbr> interference/perturbation
wrap-around: Problematic <abbr title="field-of-view">FoV</abbr> prescription / wrap-around
ghost-aliasing: Aliasing ghosts
ghost-other: Other ghosts (for example, <abbr title="radiofrequency">RF</abbr> spoiling)
inu: Intensity non-uniformity (B<sub>1</sub> bias)
field-variation: Temporal B<sub>1</sub> field non-uniformity variation
processing: Processing such as denoising, defacing or resamplings happened
uncategorized: Other uncategorized artifact(s)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@celprov this should facilitate the customization of options for the modality at hand (nipreps/mriqc#1009)

@oesteban oesteban requested review from celprov and effigies March 23, 2023 16:00
@oesteban
Copy link
Member Author

@celprov @effigies if you can't give quick feedback just now, please let me know so I can merge. I would prefer to advance on nipreps/mriqc#1085 and use that as test bed.

@effigies
Copy link
Member

I don't have time to review this promptly.

@oesteban oesteban merged commit 7424386 into main Mar 23, 2023
@oesteban oesteban deleted the enh/57-rating-widget branch March 23, 2023 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants