expyfun.analyze.format_pval

expyfun.analyze.format_pval(pval, latex=True, scheme='default')

Format a p-value using one of several schemes.

Parameters:

pvalfloat | array-like

The raw p-value(s).

latexbool

Whether to use LaTeX wrappers suitable for use with matplotlib.

schemestr

A keyword indicating the formatting scheme. Currently supports “stars”, “ross”, and “default”; any other string will yield the same as “default”.

Returns:

pvstr | np.objectarray

A string or array of strings of formatted p-values. If a list output is preferred, users may call .tolist() on the output of the function.