Skip to content

msmu._read_write._reader_registry

read_diann module-attribute

read_diann = _ReadDiannFacade()

Alias for :class:_ReadDiannFacade.

Parameters:

Name Type Description Default
search_dir str | Path

Path to the DIA-NN output directory.

required

Returns:

Type Description
_ReadDiannFacade

md.MuData: A MuData object containing the DIA-NN data at precursor level

Usage

mdata_precursor = mm.read_diann(search_dir) mdata_protein_group = mm.read_diann.from_pg(search_dir)

read_fragpipe module-attribute

read_fragpipe = FragPipeFacade()

Alias for :class:FragPipeFacade.

Parameters:

Name Type Description Default
search_dir str | Path

Path to the FragPipe output directory.

required

Returns:

Type Description
FragPipeFacade

md.MuData: A MuData object containing the FragPipe data at precursor level

Usage

mdata_precursor = mm.read_fragpipe(search_dir) mdata_protein_group = mm.read_fragpipe.from_pg(search_dir)

read_maxquant module-attribute

read_maxquant = _MaxQuantFacade()

Alias for :class:_MaxQuantFacade.

Parameters:

Name Type Description Default
search_dir str | Path

Path to the MaxQuant output directory.

required

Returns:

Type Description
_MaxQuantFacade

md.MuData: A MuData object containing the MaxQuant data at precursor level

Usage

mdata_precursor = mm.read_maxquant(search_dir) mdata_protein_group = mm.read_maxquant.from_pg(search_dir)

read_h5mu

read_h5mu(h5mu_file)

Reads an h5mu file (HDF5) and returns a MuData object.

Parameters:

Name Type Description Default
h5mu_file str | Path

Path to the H5MU file.

required

Returns:

Type Description
MuData

md.MuData: A MuData object.

read_sage

read_sage(search_dir, label, _quantification=True)

Reads Sage output and returns a MuData object.

Parameters:

Name Type Description Default
search_dir str | Path

Path to the Sage output directory.

required
label Literal['tmt', 'label_free']

Label for the Sage output ('tmt' or 'label_free').

required
_quantification bool

Whether to include quantification data. Default is True.

True

Returns:

Type Description
MuData

md.MuData: A MuData object containing the Sage data.