cellpin.pp.load_sp_example

cellpin.pp.load_sp_example(*, cache_dir=None, force_download=False)

Load the spatial example dataset used by cellpin tutorials.

Data from the 10x Genomics Xenium preview dataset (human breast, In Situ Sample 1, Replicate 1). This is the Xenium in-situ panel.

Downloads sp_example.h5ad from the cellpin data repository into a local cache directory on first use and then loads it with anndata.

Return type:

AnnData

Args:

cache_dir: Optional custom cache directory for downloaded files.

If None, defaults to ~/.cache/cellpin/datasets.

force_download: If True, always re-download the file even when a

cached copy exists.

Returns:

Loaded spatial example AnnData.