Skip to content

Commit

Permalink
Add note to README about generated GT fields
Browse files Browse the repository at this point in the history
  • Loading branch information
tomwhite committed Jul 18, 2024
1 parent 5b3b0c5 commit 401c202
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,10 @@ For that reason, the main use case is for testing software that parses VCF or co
to another format, since Hypothesis will generate examples that exercise many edge cases of
the VCF spec.

In particular, the generated VCFs do *not* have well-known INFO or FORMAT fields, such as `GT`
or `AD`. However, the ability to generate these fields may be added in the future.
In general, the generated VCFs do *not* have well-known INFO or FORMAT fields, such as `DP`
or `AD`. There is one exception to this: `GT` (genotype) fields are generated, since they
are found in most VCF files. The ability to generate more well-known fields may be added
in the future.

## API

Expand Down

0 comments on commit 401c202

Please sign in to comment.