mne_denoise.viz.plot_endpoint_metrics_summary#
- mne_denoise.viz.plot_endpoint_metrics_summary(data, metric_col, group_col='group', subject_col='subject', group_order=None, group_colors=None, group_labels=None, reference_value=None, reference_label='Reference', null_distribution=None, observed_value=None, title='Endpoint Metrics Summary', show=True, fname=None)[source]#
Plot a generic endpoint-metric storyboard.
- Parameters:
- datamapping[str, array-like]
Columnar mapping with at least
metric_col,group_col, andsubject_col.- metric_colstr
Metric column to summarize.
- group_colstr
Group identifier column.
- subject_colstr
Subject identifier column.
- group_ordersequence of str | None, default=None
Optional group order. Defaults to first-seen order.
- group_colorsmapping | None, default=None
Optional color overrides keyed by group.
- group_labelsmapping | None, default=None
Optional display-label overrides keyed by group.
- reference_valuefloat | None
Optional horizontal reference line for metric panels.
- reference_labelstr
Label for
reference_value.- null_distributionarray-like | None
Optional null distribution for the null panel.
- observed_valuefloat | None
Observed statistic for the null panel.
- titlestr
Figure title.
- showbool
Whether to show the figure.
- fnamepath-like | None
Optional output path.
- Returns:
- figmatplotlib.figure.Figure
Figure handle.
- Raises:
- KeyError
If required columns are missing from
data.- ValueError
If numeric conversion or plotting operations receive incompatible shapes.