mne-tools / mne-bids-pipeline

Automatically process entire electrophysiological datasets using MNE-Python.
https://mne.tools/mne-bids-pipeline/
BSD 3-Clause "New" or "Revised" License
138 stars 66 forks source link

Reconsider how we add original and auto-bads-processed data to the report #932

Open hoechenberger opened 5 months ago

hoechenberger commented 5 months ago

Originally posted by @larsoner in https://github.com/mne-tools/mne-bids-pipeline/issues/931#issuecomment-2072320956

Should we only set the pre-existing bads when generating the HTML repr for the original data, or should we set the pre-existing bads + all bads from the data quality checks?

To me the optimal thing to do here I think is to have two report entries:

  1. One which is the data as it comes originally from the dataset author with bads from the sidecar. It tells you what you start with before doing anything to it with the pipeline
  2. Another which is the data after our autobads (this section only needs to exist if we do some autobad detection). It tells you what the automated approaches did to the data

To me it's okay for brevity to have (1) have all the nice raw data plots, and have (2) maybe have less -- like just a list of channels removed or something? I think we're already kind of close to this organization:

image

But from that data quality plot it's not immediately clear which channels were added as bad, if any. Even just a HTML entry that lists the bads (when bad enabled) and flats (when flat enabled) would be a nice help