multigedi.io.write_h5mu

multigedi.io.write_h5mu(mdata, filename, *, compression='gzip', compression_opts=None)[source]

Write a mudata.MuData object to an H5MU file.

Wrapper around mudata.MuData.write_h5mu() with a consistent interface matching multigedi.io.write_h5ad().

Parameters:

  • mdata (MuData) – Multi-modal annotated data container to write.

  • filename (str | Path) – Path to the output H5MU file.

  • compression (str | None, default: 'gzip') – Compression algorithm. Options: 'gzip', 'lzf', None.

  • compression_opts (int | None, default: None) – Compression level (for gzip, 1-9).

Return type:

None

Examples

>>> import multigedi as gd
>>> gd.io.write_h5mu(mdata, "results.h5mu")