multigedi.io.read_h5mu¶

multigedi.io.read_h5mu(filename, *, backed=None)[source]¶

Read an H5MU file into a mudata.MuData object.

Wrapper around mudata.read_h5mu() with a consistent interface matching multigedi.io.read_h5ad().

Parameters:

filename (str | Path) – Path to the H5MU file.
backed (str | None, default: None) – If 'r', open in read-only backed mode. If 'r+', open in read-write backed mode. If None, load into memory.

Return type:

Multi-modal annotated data container.

Examples

>>> import multigedi as gd
>>> mdata = gd.io.read_h5mu("data.h5mu")
>>> gd.tl.multigedi(mdata, modalities={"gene": {}}, sample_key="sample")