plot_blandaltman_annotations#

mobgap.plotting.plot_blandaltman_annotations( error: Series, ax: Axes | None = None, agreement: float = 1.96, confidence: float = 0.95, ) → Axes[source]#

Add annotations (mean and confidence interval) to a blandaltman style plot.

Code modified based on penguin

Parameters:

error: values typically plotted on the y-axis of the blandaltma plot
agreementfloat: Multiple of the standard deviation to draw confidenc interval line
confidencefloat: CIs for the limits of agreement and the mean
axmatplotlib axes: Axis on which to draw the plot.

Returns:

axMatplotlib Axes instance: Returns the Axes object with the plot for further tweaking.