harpy.datasets.visium_hd_example

harpy.datasets.visium_hd_example#

harpy.datasets.visium_hd_example(bin_size=16, output=None, path=None)#

Example transcriptomics dataset

Parameters:

  • bin_size (int | list[int] (default: 16)) – When specified, load the data of a specific bin size, or a list of bin sizes. By default, it loads all the available bin sizes.

  • output (str | Path | None (default: None)) – The path where the resulting SpatialData object will be backed. If None, it will not be backed to a zarr store. We recommend specifying output.

  • path (str | Path | None (default: None)) – If None, the example data will be downloaded into the default cache directory for your OS. Provide a custom path to change this behavior.

Return type:

SpatialData

Returns:

: A SpatialData object.