hail.vds.filter_samples

hail.vds.filter_samples(vds, samples, *, keep=True, remove_dead_alleles=False)[source]

Filter samples in a VariantDataset.

Parameters:

  • vds (VariantDataset) – Dataset in VariantDataset representation.

  • samples (Table or list of str) – Samples to keep or remove.

  • keep (bool) – Whether to keep (default), or filter out the samples from samples_table.

  • remove_dead_alleles (bool) – If true, remove alleles observed in no samples. Alleles with AC == 0 will be removed, and LA values recalculated.

Returns:

VariantDataset