c2v.pl.graph#
- c2v.pl.graph(adata, graph_key='connectivities', basis='X_umap', oriented=False, ax=None, return_fig=False, show=False, linewidth=1.0, linecolor='black', linealpha=1.0, arrowstyle=None, mutation_scale=10.0, width_condition=None, color_condition=None, figsize=None, **kwargs)#
Draws graph on top of the embedding.
- Parameters:
- adata sc.AnnData
AnnData object with graph in obsp[graph_key].
- graph_key str, optional
Key in obsp to store graph. Default is “connectivities”.
- basis str, optional
Key in obsm to store embedding. Default is “X_umap”.
- oriented bool, optional
Whether to draw oriented edges. Default is False.
- ax matplotlib.axes.Axes, optional
Axes to draw on. Default is None.
- return_fig bool, optional
Whether to return figure. Default is False.
- linewidth float, optional
Line width. Default is 1.
- linecolor str, optional
Line color. Default is “black”.
- linealpha float, optional
Line alpha. Default is 1.
- arrowstyle str, optional
Arrow style. Default is None.
- mutation_scale float, optional
Mutation scale. Default is 10.
- width_condition Callable, optional
Function to calculate line width. Default is None.
- color_condition Callable, optional
Function to calculate line color. Default is None.
- figsize tuple[float, float], optional
Figure size. Default is None.
- **kwargs dict, optional
Additional keyword arguments for sc.pl.embedding.
- show bool
- Return type:
matplotlib.axes.Axes | matplotlib.figure.Figure | None
- Returns:
matplotlib.axes.Axes | matplotlib.figure.Figure | None Draws with the graph on top.