missionbio.mosaic.io.load¶

missionbio.mosaic.io.load(filepath, name=None, raw=False, update=False, apply_filter=False, whitelist=None)¶

Loading the .h5 file with one or more assays.

This is the preferred way of loading .h5 files.

It directly returns a Sample object, which contains all the assays. Those assays that were not present are stored as None.

Parameters

filepathstr: The path to the .h5 multi-omics file.
namestr: Name to be given to the sample. If None, then the dna sample name from the h5 file is used.
rawbool: Whether the raw counts are to be loaded.
updatebool: Whether the file is to be updated if the .h5 format is not supported.
apply_filterTrue: Whether to load only the filtered dna variants.
whitelistlist-like: The specific dna variants to load.

Returns

Raises

Mosaic