eelbrain.plot.Timeplot

class eelbrain.plot.Timeplot(y, categories, time, match=None, sub=None, ds=None, main=<function mean>, error='sem', x_jitter=False, bottom=None, top=None, ylabel=True, xlabel=True, timelabels=None, legend='upper right', labels=None, colors=None, hatch=False, markers=True, *args, **kwargs)

Plot a variable over time

Parameters:
y : Var

Dependent variable.

categories : categorial

Model (Factor or Interaction)

time : Var

Variable describing the time.

match : None | categorial

Match cases for a repeated measures design.

sub : None | index-array

Use a subset of the data.

ds : None | Dataset

If a Dataset is specified, all data-objects can be specified as names of Dataset variables

main : numpy function

draw lines to connect values across time (default: np.mean). Can be ‘bar’ for barplots or False.

error : str | False

How to indicate estimate error. For complete within-subject designs, the within-subject measures are displayed (see Loftus & Masson, 1994). Options: ‘box’: boxplots; ‘[x]sem’: x standard error of the means (e.g. ‘sem’, ‘2sem’); ‘[x]std’: x standard deviations.

x_jitter : bool

When plotting error bars, jitter their location on the x-axis to increase readability.

bottom : scalar

Lower end of the y axis (default is 0).

top : scalar

Upper end of the y axis (default is determined from the data).

ylabel : str | None

y axis label (default is inferred from the data).

xlabel : str | bool

x axis label (default is inferred from the data).

timelabels : sequence | dict | ‘all’

Labels for the x (time) axis. Exact labels can be specified in the form of a list of labels corresponsing to all unique values of time, or a {time_value: label} dictionary. For ‘all’, all values of time are marked. The default is normal matplotlib ticks.

legend : str | int | ‘fig’ | None

Matplotlib figure legend location argument or ‘fig’ to plot the legend in a separate figure.

labels : dict

Alternative labels for legend as {cell: label} dictionary (preserves order).

colors : str | list | dict

Colors for the categories. str: A colormap name; cells are mapped onto the colormap in regular intervals. list: A list of colors in the same sequence as the cells. dict: A dictionary mapping each cell to a color. Colors are specified as matplotlib compatible color arguments.

Also accepts General layout parameters.

Methods

add_hline(self, y[, axes]) Draw a horizontal line on one or more axes
add_hspan(self, bottom, top[, axes]) Draw a horizontal bar on one or more axes
add_vline(self, x[, axes]) Draw a vertical line on one or more axes
add_vspan(self, xmin, xmax[, axes]) Draw a vertical bar on one or more axes
close(self) Close the figure.
draw(self) (Re-)draw the figure (after making manual changes).
draw_crosshairs(self[, enable]) Draw crosshairs under the cursor
get_ylim(self)
image(self[, name, format]) Create FMTXT Image from the figure
plot_legend(self[, loc, labels]) Plot the legend (or remove it from the figure).
save(self, *args, **kwargs) Short-cut for Matplotlib’s savefig()
save_legend(self, *args, **kwargs) Save the legend as image file
set_name(self, name) Set the figure window title
set_xlabel(self, label[, ax]) Set the label for the x-axis
set_xtick_rotation(self, rotation) Rotate every x-axis tick-label by an angle (counterclockwise, in degrees)
set_ylabel(self, label[, ax]) Set the label for the y-axis
set_ylim(self[, bottom, top]) Set the y-axis limits