get_variants

Contents

get_variants#

missionbio.mosaic.io.get_variants

get_variants(filepath: Any, filter_variants: bool = True, whitelist: Optional[Sequence] = None, variant_filter_config: Optional[Dict[str, float]] = None) ndarray#

Get the appropriate DNA variants.

Detailed description of the options can be found in the load() function.

Parameters:
filepath:

Path to the h5 file. This file must contain the “dna_variants” assay.

filter_variants:

Whether to consider default filters when loading.

whitelist:

The specific dna variants to load.

variant_filter_config:

The filters to apply to the variants. This is useful when the default filters are not suitable.

Returns:
np.ndarray:

The variants of interest in the h5 file

See also

load()

< Module io