bento.ut.set_shape_metadata

bento.ut.set_shape_metadata(sdata, shape_key, metadata, column_names=None)

Write metadata in SpatialData shapes element as column(s). Aligns metadata index to shape index.

Parameters:
  • sdata (SpatialData) – Spatial formatted SpatialData object

  • shape_key (str) – Name of element in sdata.shapes

  • metadata (pd.Series, pd.DataFrame) – Metadata to set for shape. Index must be a (sub)set of shape index.

  • column_names (str or list of str, optional) – Name of column(s) to set. If None, use metadata column name(s), by default None