c2v.pl.scatter2vars

Contents

c2v.pl.scatter2vars#

c2v.pl.scatter2vars(adata, var1, var2, clip1=None, clip2=None, c1='red', c2='blue', basis='X_umap', use_raw=None, components=None, s=None, alpha=1.0, frameon=True, title=None, ax=None, rasterize=False, ticks=False, round_ticks=2, bright_level=0.8, grey_level=0.9, show=True, return_fig=False, cbar=True, figsize=None)#

Plots embedding colored by two continious variables.

Parameters:
adata sc.AnnData

Annotated data matrix.

var1 str

Key for variable 1.

var2 str

Key for variable 2.

clip1 tuple[float, float] | None

Clip values for variable 1. Default is None.

clip2 tuple[float, float] | None

Clip values for variable 2. Default is None.

c1 Literal["red", "green", "blue"]

Color for variable 1. Default is “red”.

c2 Literal["red", "green", "blue"]

Color for variable 2. Default is “blue”.

basis str

Key for embedding. Default is “X_umap”.

use_raw bool | None

Whether to use raw data. Default is None.

components str | None

Components to use. Default is None.

s float | None

Size of points. Default is None.

alpha float

Transparency of points. Default is 1.

frameon bool

Whether to draw frame. Default is True.

title str | None

Title for the plot. Default is None.

ax matplotlib.axes.Axes | None

Axes object to draw on. Default is None.

rasterize bool

Whether to rasterize points. Default is False.

ticks bool

Whether to draw ticks. Default is False.

round_ticks int

Number of decimal places to round ticks. Default is 2.

bright_level float

Brightness level for points. Default is 0.8.

grey_level float

Grey level for points. Default is 0.9.

show bool

Whether to show the plot. Default is True.

return_fig bool

Whether to return figure object. Default is False.

cbar bool

Whether to draw colorbar. Default is True.

figsize tuple[float, float] | None

Figure size. Default is None.

Return type:

Axes | Figure | None

Returns:

matplotlib.axes.Axes | matplotlib.figure.Figure | None Axes object with the plot or figure if return_fig is True. None if show is False.