Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding small warning messages to not to feed any GVCF files to these tools #9008

Merged
merged 4 commits into from
Oct 18, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@
* </pre>
*
* <h3>Caveat</h3>
gokalpcelik marked this conversation as resolved.
Show resolved Hide resolved
* <p>This tool outputs no annotations by default, all annotations/groups must be specified explicitly. </p>
* <p>This tool outputs no annotations by default, all annotations/groups must be specified explicitly. This tool acceps VCF format files only. Using GVCF files as input may result in unexpected behavior. </p>
gokalpcelik marked this conversation as resolved.
Show resolved Hide resolved
*
* <h3>Special note on RankSumTestAnnotations</h3>
* <p>RankSumAnnotations produced by this tool are not the same as those produced by the HaplotypeCaller. Without the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
* <li>If there are multiple variants that start at a site, it chooses one of them randomly.</li>
* <li>When there are overlapping indels (but with different start positions) only the first will be chosen.</li>
* <li>This tool works only for SNPs and for simple indels (but not for things like complex substitutions).</li>
* <li>This tool works only with VCF files. Using GVCF files as input may result in unexpected behavior.</li>
* </ul>

* <h3>Input</h3>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@
* <h3>Additional notes</h3>
* <ul>
* <li>This tool only accepts a single input variant file unlike earlier version of GATK, which accepted multiple
* input variant files.</li>
* input variant files. Please do not provide non-genotyped GVCF files as input as it will not work properly with this tool.</li>
gokalpcelik marked this conversation as resolved.
Show resolved Hide resolved
* <li>SNPs and indels must be recalibrated in separate runs, but it is not necessary to separate them into different
* files. See the tutorial linked above for an example workflow. Note that mixed records are treated as indels.</li>
* <li></li>
Expand Down
Loading