mudata.read_h5mu

Contents

mudata.read_h5mu#

mudata.read_h5mu(filename, backed=None)#

Read an .h5mu-formatted HDF5 file.

Parameters:

  • filename (str | PathLike | IOBase | OpenFile) – The file name or an fsspec object.

  • backed (Literal['r', 'r+'] | bool | None (default: None)) – Whether to open the file in backed mode. In this mode, the data matrices X are not read into memory, but are references to the on-disk datasets.

Return type:

MuData

Examples

>>> mdata = read_h5mu("file.h5mu")

>>> with fsspec.open("https://example.com/file.h5mu") as f:
...     mdata = read_h5mu(f)
Contents