dandelion.base.tools.clone_view

dandelion.base.tools.clone_view(adata, mode='expanded', connectivities_key=None, distances_key=None, embedding_key=None)[source]

Swap the ‘active’ connectivities, distances, and optionally embedding in AnnData.

Parameters:

  • adata (AnnData) – The AnnData object.

  • mode (Literal[“all”, “expanded”, “full”, “gex”] | None, optional) – If specified, set the active connectivities/distances/embedding to one of the preset modes.

  • connectivities_key (str | None, optional) – The key in .obsp to set as active .obsp[“connectivities”] if mode is None.

  • distances_key (str | None, optional) – The key in .obsp to set as active .obsp[“distances”] if mode is None.

  • embedding_key (str | None, optional) – If specified, set .obsm[“X_vdj”] to .obsm[embedding_key] if mode is None.

Raises:

KeyError – if the requested connectivities, distances, or embedding key is not found.