mtopic.read.h5mu

Contents

mtopic.read.h5mu#

mtopic.read.h5mu(path)#

Load a MuData object from an .h5mu file.

This function reads a MuData object from the specified .h5mu file using the muon library. The .h5mu format is specifically designed for storing multimodal single-cell data, enabling efficient handling of large datasets across multiple modalities in a unified structure.

Parameters:

path (str) – The file path to the .h5mu file containing the MuData object.

Returns:

A MuData object loaded from the specified file.

Return type:

muon.MuData

Example:
import mtopic

# Load the MuData object
mdata = mtopic.read.h5mu("path/to/file.h5mu")