cellpin.pp.load_sc_example

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

Load the single-cell 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 matching FRP (Fixed RNA Profiling) scRNA-seq sample.

Downloads sc_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 single-cell example AnnData.