bento.ut.get_points_metadata

bento.ut.get_points_metadata(sdata, metadata_keys, points_key, astype='pandas') → DataFrame | DataFrame

Get metadata columns from points data.

Parameters:

• sdata (SpatialData) – Input SpatialData object

• metadata_keys (str or list of str) – Column name(s) to retrieve

• points_key (str) – Key for points in sdata.points

• astype (str, default “pandas”) – Return type: ‘pandas’ or ‘dask’

Returns:

Requested metadata columns

Return type:

Union[pd.DataFrame, dd.DataFrame]

Raises:

ValueError – If points_key or metadata_keys not found