zzh
/
gatk-3.8
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document how VTT orders samples in output table

This commit is contained in:
Ron Levine 2017-03-21 12:55:30 -04:00
parent c449b133d0
commit 4188745074
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
public/gatk-tools-public/src/main/java/org/broadinstitute/gatk/tools/walkers/variantutils/VariantsToTable.java
View File

@ -69,12 +69,10 @@ import java.util.*;
* </p>
*
* <h3>Input</h3>
* <p>
* <ul>
* <li>A VCF file</li>
* <li>A list of -F fields to write</li>
* </ul>
* </p>
*
* <h3>Output</h3>
* <p>
@ -98,9 +96,11 @@ import java.util.*;
* et cetera...
* </pre>
*
* <h3>Caveat</h3>
* <p>If a VCF record is missing a value, then the tool by default throws an error, but the special value NA can
* be emitted instead if requested at the command line using --allowMissingData.</p>
* <h3>Caveats</h3>
* <ul>
* <li>Some annotations cannot be applied to all variant sites, so VCFs typically contain records where some annotation values are missing. By default this tool throws an error if you request export of an annotation for which not all records have values. You can override this behavior by setting --allowMissingData in the command line. As a result, the tool will emit the special value NA for the missing annotations in those records.</li>
* <li>When you request export of sample-level annotations (FORMAT field annotations such as GT), the annotations will be identified per-sample. If multiple samples are present in the VCF, the columns will be ordered alphabetically by sample name (SM tag).</li>
* </ul>
*
* @author Mark DePristo
* @since 2010