quail.plot

quail.plot(results, subjgroup=None, subjname='Subject Group', listgroup=None, listname='List', subjconds=None, listconds=None, plot_type=None, plot_style=None, title=None, legend=True, xlim=None, ylim=None, save_path=None, show=True, ax=None, **kwargs)[source]

General plot function that groups data by subject/list number and performs analysis.

Parameters:
results : quail.FriedEgg

Object containing results

subjgroup : list of strings or ints

String/int variables indicating how to group over subjects. Must be the length of the number of subjects

subjname : string

Name of the subject grouping variable

listgroup : list of strings or ints

String/int variables indicating how to group over list. Must be the length of the number of lists

listname : string

Name of the list grouping variable

subjconds : list

List of subject hues (str) to plot

listconds : list

List of list hues (str) to plot

plot_type : string

Specifies the type of plot. If list (default), the list groupings (listgroup) will determine the plot grouping. If subject, the subject groupings (subjgroup) will determine the plot grouping. If split (currenty just works for accuracy plots), both listgroup and subjgroup will determine the plot groupings

plot_style : string

Specifies the style of the plot. This currently works only for accuracy and fingerprint plots. The plot style can be bar (default for accruacy plot), violin (default for fingerprint plots) or swarm.

title : string

The title of the plot

legend : bool

If true (default), a legend is plotted.

ylim : list of numbers

A ymin/max can be specified by a list of the form [ymin, ymax]

xlim : list of numbers

A xmin/max can be specified by a list of the form [xmin, xmax]

save_path : str

Path to save out figure. Include the file extension, e.g. save_path=’figure.pdf’

show : bool

If False, do not show figure, but still return ax handle (default True).

ax : Matplotlib.Axes object or None

A plot object to draw to. If None, a new one is created and returned.

Returns:
ax : matplotlib.Axes.Axis

An axis handle for the figure