missionbio.mosaic.io.load_example_dataset

missionbio.mosaic.io.load_example_dataset(path: str, single: bool = False) → Union[missionbio.mosaic.sample.Sample, missionbio.mosaic.samplegroup.SampleGroup]

Load a sample dataset

Parameters

path:

Either a link from where the h5 file is pulled or one of {“3 cell mix”, “2 PBMC mix”, “Multisample PBMC”}

single:

Whether to load as a single sample despite being a multi sample h5 file (Not a recommended approach). Only use this for debugging issues.

Returns

An example sample object

Examples

>>> import missionbio.mosaic as ms
>>> sample = ms.load_example_dataset("3 cell mix")
>>> sample.name
... "3 cell mix"