Adding small warning messages to not to feed any GVCF files to these …

…tools (#9008) * Adding small warning messages to not to feed any GVCF files to these tools. * Update src/main/java/org/broadinstitute/hellbender/tools/walkers/vqsr/VariantRecalibrator.java Co-authored-by: Louis Bergelson <[email protected]> * Update src/main/java/org/broadinstitute/hellbender/tools/walkers/annotator/VariantAnnotator.java Co-authored-by: Louis Bergelson <[email protected]> * Update src/main/java/org/broadinstitute/hellbender/tools/walkers/annotator/VariantAnnotator.java Co-authored-by: Louis Bergelson <[email protected]> --------- Co-authored-by: Louis Bergelson <[email protected]>
broadinstitute · Oct 18, 2024 · f5a2256 · f5a2256
1 parent 87e9f1f
commit f5a2256
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/src/main/java/org/broadinstitute/hellbender/tools/walkers/annotator/VariantAnnotator.java b/src/main/java/org/broadinstitute/hellbender/tools/walkers/annotator/VariantAnnotator.java
@@ -91,8 +91,8 @@
  *   --expression foo.FILTER
  * </pre>
  *
- * <h3>Caveat</h3>
- * <p>This tool outputs no annotations by default, all annotations/groups must be specified explicitly. </p>
+ * <h3>Caveats</h3>
+ * <p>This tool outputs no annotations by default, all annotations/groups must be specified explicitly. This tool accepts VCF format files only. Using GVCF files as input may result in unexpected behavior. </p>
  *
  * <h3>Special note on RankSumTestAnnotations</h3>
  * <p>RankSumAnnotations produced by this tool are not the same as those produced by the HaplotypeCaller. Without the

diff --git a/.../java/org/broadinstitute/hellbender/tools/walkers/fasta/FastaAlternateReferenceMaker.java b/.../java/org/broadinstitute/hellbender/tools/walkers/fasta/FastaAlternateReferenceMaker.java
@@ -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>

diff --git a/src/main/java/org/broadinstitute/hellbender/tools/walkers/vqsr/VariantRecalibrator.java b/src/main/java/org/broadinstitute/hellbender/tools/walkers/vqsr/VariantRecalibrator.java
@@ -140,7 +140,8 @@
  * <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. </li>
+ *     <li>The input VCF must be genotyped, raw GVCF files will not work correctly.</li>
  *     <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>