breast_cancer_atlas#

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

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

Download and load the breast cancer cell atlas from CELLxGENE.

Parameters:

  • cache_directory (str | Path | PathLike) – Directory where the .h5ad 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 regenerate from scratch.

  • 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:

AnnData – The breast cancer atlas dataset.

Raises:

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

Notes

Thin wrapper around from_cellxgene with the atlas UUID baked in.

On this page