episcanpy.pl.violin

episcanpy.pl.violin(adata, keys, groupby=None, log=False, use_raw=None, stripplot=True, jitter=True, size=1, layer=None, scale='width', order=None, multi_panel=None, xlabel='', rotation=None, show=None, save=None, ax=None, **kwds)

Violin plot.

Wraps seaborn.violinplot() for AnnData.

Parameters

adata : AnnDataAnnData

Annotated data matrix.

keys : str, Sequence[str]Union[str, Sequence[str]]

Keys for accessing variables of .var_names or fields of .obs.

groupby : str, NoneOptional[str] (default: None)

The key of the observation grouping to consider.

log : boolbool (default: False)

Plot on logarithmic axis.

use_raw : bool, NoneOptional[bool] (default: None)

Use raw attribute of adata if present.

stripplot : boolbool (default: True)

Add a stripplot on top of the violin plot. See stripplot().

jitter : float, boolUnion[float, bool] (default: True)

Add jitter to the stripplot (only when stripplot is True) See stripplot().

size : intint (default: 1)

Size of the jitter points.

layer : str, NoneOptional[str] (default: None)

Name of the AnnData object layer that wants to be plotted. By default adata.raw.X is plotted. If use_raw=False is set, then adata.X is plotted. If layer is set to a valid layer name, then the layer is plotted. layer takes precedence over use_raw.

scale : Literal_[area, count, width]Literal_[area, count, width] (default: 'width')

The method used to scale the width of each violin. If ‘width’ (the default), each violin will have the same width. If ‘area’, each violin will have the same area. If ‘count’, a violin’s width corresponds to the number of observations.

order : Sequence[str], NoneOptional[Sequence[str]] (default: None)

Order in which to show the categories.

multi_panel : bool, NoneOptional[bool] (default: None)

Display keys in multiple panels also when groupby is not None.

xlabel : strstr (default: '')

Label of the x axis. Defaults to groupby if rotation is None, otherwise, no label is shown.

rotation : float, NoneOptional[float] (default: None)

Rotation of xtick labels.

show : bool, NoneOptional[bool] (default: None)

Show the plot, do not return axis.

save : bool, str, NoneUnion[bool, str, None] (default: None)

If True or a str, save the figure. A string is appended to the default filename. Infer the filetype if ending on {‘.pdf’, ‘.png’, ‘.svg’}.

ax : Axes, NoneOptional[Axes] (default: None)

A matplotlib axes object. Only works if plotting a single component.

**kwds

Are passed to violinplot().

Returns

A Axes object if ax is None else None.