Skip to content

msmu.utils.reindex_obs

Reindex the observation (.obs) of the MuData object to ensure consistency across modalities.

Parameters:

Name Type Description Default
mdata MuData

MuData with the requested column in both global .obs and every modality .obs.

required
column str

Column whose string-converted values become observation names.

required

Returns:

Type Description
MuData

A copied MuData with global and modality observation indices replaced. The old index is retained as a column by reset_index.

Notes

Missing columns raise KeyError. Use identifiers consistent across modalities; the input is unchanged.

Examples:

import msmu as mm
renamed = mm.utils.reindex_obs(mdata, column="sample")