Skip to content

Commit 3f58b3a

Browse files
tomwhitemergify[bot]
authored andcommitted
Add note to max_alt_alleles docstring about how call fields are unaffected.
1 parent 718fe3b commit 3f58b3a

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

sgkit/io/vcf/vcf_reader.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -615,7 +615,8 @@ def vcf_to_zarrs(
615615
specified ploidy will raise an exception.
616616
max_alt_alleles
617617
The (maximum) number of alternate alleles in the VCF file. Any records with more than
618-
this number of alternate alleles will have the extra alleles dropped.
618+
this number of alternate alleles will have the extra alleles dropped (the `variant_allele`
619+
variable will be truncated). Call genotype fields will however be unaffected.
619620
fields
620621
Extra fields to extract data for. A list of strings, with ``INFO`` or ``FORMAT`` prefixes.
621622
Wildcards are permitted too, for example: ``["INFO/*", "FORMAT/DP"]``.
@@ -782,7 +783,8 @@ def vcf_to_zarr(
782783
specified ploidy will raise an exception.
783784
max_alt_alleles
784785
The (maximum) number of alternate alleles in the VCF file. Any records with more than
785-
this number of alternate alleles will have the extra alleles dropped.
786+
this number of alternate alleles will have the extra alleles dropped (the `variant_allele`
787+
variable will be truncated). Call genotype fields will however be unaffected.
786788
fields
787789
Extra fields to extract data for. A list of strings, with ``INFO`` or ``FORMAT`` prefixes.
788790
Wildcards are permitted too, for example: ``["INFO/*", "FORMAT/DP"]``.

0 commit comments

Comments
 (0)