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

DOC: Document quality control procedures / ideas / reports

Open larsoner opened this issue 1 month ago • 3 comments

Our current report tutorial is more or less "here's some stuff you can do with the Report!" This is useful, but a complementary thing we should add is something along the lines of "here are some ways you can and should QC your dataset!" I'm thinking we should build it off of the sample dataset, and build a report similar to the one created by mne-bids-pipeline.

I considered possibly just linking to mne-bids-pipeline, but the code for actually generating reports over there is distributed over multiple files and quite scattered, so I think we should just cross-reference to it instead, saying "this is the sort of end result you can produce".

I thought of this while working on the refit_hpi code, there doesn't really seem to be a good home for that currently in our docs and a QC report would be one place it could fit.

larsoner avatar Nov 17 '25 16:11 larsoner

Hi, I would like to work on this!

If no one else is currently working on this, could you please assign me to it? I’m happy to get started!

Thanks!

varshaa-1616 avatar Dec 03 '25 12:12 varshaa-1616

No need to assign I think, feel free to open a PR when you're ready

larsoner avatar Dec 03 '25 14:12 larsoner

Oh okay, thank you! I’ve started exploring the current documentation and examples to understand the existing structure. I’ll begin drafting the new QC tutorial and open a PR once I have an initial version ready.

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