pbmc_cite#

API pages include interactive (HTML) plots that would possibly not render correctly on a mobile device.

pbmc_cite(cache_directory: str | Path | PathLike = _GLOBAL_CACHE, *, use_cache: bool = True, bring: bool = True) → MuData#

Download and load a small multimodal CITE-seq PBMC dataset.

Parameters:

  • cache_directory (str | Path | PathLike) – Directory where the .h5mu file is cached.

  • use_cache (bool, default True) – If True, load from the cached file when present. If False, remove any existing cached file and re-download.

  • bring (bool, default True) – If True and cache_directory is not the default global cache, copy the file from the global cache when it already exists there. Set to False to disable this behavior.

Returns:

MuData – 411 cells with paired gene expression (rna) and surface protein (prot) modalities, carrying joint WNN and MOFA embeddings.

Raises:

OSError – If the downloaded file size does not match the expected size.

On this page