Plexora

register_spatialdata_datasource

Register one table of a SpatialData (.zarr) store as a project.

Generated from Plexora 0.0.55View source
from plexora import register_spatialdata_datasource
register_spatialdata_datasource(name, image, store, table, **kwargs)

A thin wrapper over plexora.register_anndata_datasource -- a SpatialData table is itself an AnnData, so every keyword that function accepts (coordinate_source, feature_source, subset_by, celltype_column, channel_names, copy, data_dir, segmentation_mode, image_type, ...) behaves exactly as it does there. Only the named table is read, never the whole store.

When to use

Reach for this when the cell table already lives in a SpatialData store; it names store and table directly instead of the (features, table) pair register_anndata_datasource would otherwise need. For a plain .h5ad or a flat CSV, use plexora.register_anndata_datasource or plexora.register_datasource instead; plexora.create_project is the newer, progressive entry point for either.

Parameters

namestrrequired

The project's name.

imagestr | Pathrequired

The whole-slide image -- OME-TIFF/TIFF, DICOM, or a Zarr store. A web address is read in place.

storestr | Pathrequired

The SpatialData .zarr store.

tablestrrequired

The name of the table inside store to load.

**kwargs

Forwarded to plexora.register_anndata_datasource, which documents each one.

Returns

dict

The project's saved config entry.

Examples

import plexora

plexora.register_spatialdata_datasource(
    "tonsil", image="slide.ome.tif", store="cells.zarr",
    table="table",
)

Guides

On this page