Module `plottools.significance`

Indicating statsitical significance.

Axes member functions

significance_bar(): horizontal bar with asterisks indicating significance level.

Install/uninstall significance functions

You usually do not need to call these functions. Upon loading the significance module, install_significance() is called automatically.

install_significance(): install functions of the significance module in matplotlib.
uninstall_significance(): uninstall all code of the significance module from matplotlib.

Functions

def significance_bar(ax, p, x0, x1, y, **kwargs)

A horizontal bar with asterisks indicating significance level.

Plot a horizontal bar from x0 to x1 at height y for indicating significance. On top of the bar plot asterisks according to the significance value p are drawn. If p > 0.05 nothing is plotted. p<0.001: '', p<0.01: '', p<0.05: ''.

Note: call this function AFTER ylim has been set!

Parameters

ax : matplotlib axes: Axes to which the inset is added.
p : float: Significance level.
x0 : float: x-coordinate of starting point of significance bar in data units.
x1 : float: x-coordinate of ending point of significance bar in data units.
y : float: y-coordinate of significance bar in data units.
kwargs : key-word arguments: Passed on to ax.text() used to print the asterisks.

def install_significance()

Install significance functions on matplotlib axes.

This function is also called automatically upon importing the module.