mne-python icon indicating copy to clipboard operation
mne-python copied to clipboard

Add QC + Full MNE Report tutorial

Open varshaa-1616 opened this issue 3 weeks ago • 1 comments

Reference issue

Fixes #13493

What does this implement/fix?

This PR implements a combined QC + Full MNE report workflow.
It merges the essential QC steps used in the mne-bids-pipeline with the standard MNE report features, allowing users to generate a comprehensive HTML report without requiring anatomical dependencies (BEM, coregistration, or forward/inverse solutions).

The report includes:

  • Raw data overview and PSD plots
  • Event visualization
  • Epochs overview
  • ICA diagnostics
  • Evoked responses
  • Covariance and projectors
  • Custom figures, images, and code

Additional information

  • Tested on sample MNE datasets with raw, epochs, and ICA data.
  • No changes to existing pipeline functions; fully backward compatible.
  • This PR does not include source-space analyses (BEM, forward/inverse solutions).
  • Documentation and example tutorial added for users.

varshaa-1616 avatar Dec 05 '25 20:12 varshaa-1616

Rather than changing 70_report.py the idea -- since it's complementary info -- would be to create a new tutorial/example instead

larsoner avatar Dec 11 '25 19:12 larsoner

Sorry for the delayed response — I had exams and wasn’t able to check emails or work on it earlier. I’ll create a separate tutorial instead of modifying 70_report.py by the end of the week. I'll also remove the unnecessary files. Thank you for the guidance!

On Fri, 12 Dec 2025 at 00:58, Eric Larson @.***> wrote:

larsoner left a comment (mne-tools/mne-python#13532) https://github.com/mne-tools/mne-python/pull/13532#issuecomment-3643460454

Rather than changing 70_report.py the idea -- since it's complementary info -- would be to create a new tutorial/example instead

— Reply to this email directly, view it on GitHub https://github.com/mne-tools/mne-python/pull/13532#issuecomment-3643460454, or unsubscribe https://github.com/notifications/unsubscribe-auth/BKS4EIWBTGBJJKT6M7KX2WD4BHAWVAVCNFSM6AAAAACOGCH55KVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTMNBTGQ3DANBVGQ . You are receiving this because you authored the thread.Message ID: @.***>

varshaa-1616 avatar Dec 14 '25 06:12 varshaa-1616

@larsoner Thanks for the guidance! I’ve cleaned up the PR by removing unintended files and moved the work into a new standalone tutorial under doc/tutorials/preprocessing/, without modifying 70_report.py or other core files.

Please let me know if you’d like any structural or content changes.

varshaa-1616 avatar Dec 18 '25 13:12 varshaa-1616

@larsoner Thanks for the thorough review! I’ve made the mentioned changes — please take another look. Happy to iterate further if needed.

varshaa-1616 avatar Dec 20 '25 16:12 varshaa-1616