mne_denoise.viz.plot_metric_comparison

mne_denoise.viz.plot_metric_comparison(data, metric_col, metric_label=None, group_col='group', subject_col='subject', group_order=None, group_colors=None, group_labels=None, title='Metric Comparison', reference_value=None, reference_label='Reference', ax=None, fname=None, show=True)

Plot one metric as grouped bars or paired subject trajectories.

Parameters:

datamapping of str to array-like

Columnar mapping with at least group_col and one numeric metric.

metric_colstr

Metric column to visualize.

metric_labelstr | None

Y-axis label. If None, derived from metric_col.

group_colstr

Grouping column name.

subject_colstr

Subject identifier column for paired overlays.

group_orderlist of str | None, default=None

Optional explicit group order. If None, first-seen order is used.

group_colorsdict | None, default=None

Optional color overrides keyed by group.

group_labelsdict | None, default=None

Optional display-label overrides keyed by group.

titlestr, default=”Metric Comparison”

Axes title.

reference_valuefloat | None

Optional horizontal reference line.

reference_labelstr

Legend label for reference_value.

axmatplotlib.axes.Axes | None

Existing axes. If None, create a new figure.

fnamepath-like | None

Optional output path when creating a new figure.

showbool

Whether to display the figure when creating a new figure.

Returns:

figmatplotlib.figure.Figure

Figure containing the plot.