Skip to content

Commit 7c17bac

Browse files
committed
Add note to max_alt_alleles docstring about how call fields are unaffected.
1 parent 6097b7a commit 7c17bac

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

sgkit/io/vcf/vcf_reader.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -582,7 +582,8 @@ def vcf_to_zarrs(
582582
specified ploidy will raise an exception.
583583
max_alt_alleles
584584
The (maximum) number of alternate alleles in the VCF file. Any records with more than
585-
this number of alternate alleles will have the extra alleles dropped.
585+
this number of alternate alleles will have the extra alleles dropped (the `variant_allele`
586+
variable will be truncated). Call genotype fields will however be unaffected.
586587
fields
587588
Extra fields to extract data for. A list of strings, with ``INFO`` or ``FORMAT`` prefixes.
588589
Wildcards are permitted too, for example: ``["INFO/*", "FORMAT/DP"]``.
@@ -737,7 +738,8 @@ def vcf_to_zarr(
737738
specified ploidy will raise an exception.
738739
max_alt_alleles
739740
The (maximum) number of alternate alleles in the VCF file. Any records with more than
740-
this number of alternate alleles will have the extra alleles dropped.
741+
this number of alternate alleles will have the extra alleles dropped (the `variant_allele`
742+
variable will be truncated). Call genotype fields will however be unaffected.
741743
fields
742744
Extra fields to extract data for. A list of strings, with ``INFO`` or ``FORMAT`` prefixes.
743745
Wildcards are permitted too, for example: ``["INFO/*", "FORMAT/DP"]``.

0 commit comments

Comments
 (0)