annotate variant_validate.xml @ 2:8bcc13094767 draft

Uploaded
author iuc
date Sat, 18 Jan 2014 07:21:33 -0500
parents 340633249b3d
children f244b8209eb8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
1 <tool id="gatk2_variant_validate" name="Validate Variants" version="0.0.7">
340633249b3d Uploaded
bgruening
parents:
diff changeset
2 <description></description>
340633249b3d Uploaded
bgruening
parents:
diff changeset
3 <expand macro="requirements" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
4 <macros>
340633249b3d Uploaded
bgruening
parents:
diff changeset
5 <import>gatk2_macros.xml</import>
340633249b3d Uploaded
bgruening
parents:
diff changeset
6 </macros>
340633249b3d Uploaded
bgruening
parents:
diff changeset
7 <command interpreter="python">
340633249b3d Uploaded
bgruening
parents:
diff changeset
8 gatk2_wrapper.py
340633249b3d Uploaded
bgruening
parents:
diff changeset
9 --stdout "${output_log}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
10 -d "--variant:variant,%(file_type)s" "${reference_source.input_variant}" "${reference_source.input_variant.ext}" "input_variant"
340633249b3d Uploaded
bgruening
parents:
diff changeset
11 -p '
340633249b3d Uploaded
bgruening
parents:
diff changeset
12 @JAR_PATH@
340633249b3d Uploaded
bgruening
parents:
diff changeset
13 -T "ValidateVariants"
340633249b3d Uploaded
bgruening
parents:
diff changeset
14
340633249b3d Uploaded
bgruening
parents:
diff changeset
15 \$GATK2_SITE_OPTIONS
340633249b3d Uploaded
bgruening
parents:
diff changeset
16
340633249b3d Uploaded
bgruening
parents:
diff changeset
17 #if $reference_source.reference_source_selector != "history":
340633249b3d Uploaded
bgruening
parents:
diff changeset
18 -R "${reference_source.ref_file.fields.path}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
19 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
20 ${warn_on_errors}
340633249b3d Uploaded
bgruening
parents:
diff changeset
21 ${do_not_validate_filtered_records}
340633249b3d Uploaded
bgruening
parents:
diff changeset
22 '
2
8bcc13094767 Uploaded
iuc
parents: 0
diff changeset
23 @DBSNP_OPTIONS@
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
24
340633249b3d Uploaded
bgruening
parents:
diff changeset
25 #include source=$standard_gatk_options#
340633249b3d Uploaded
bgruening
parents:
diff changeset
26 </command>
340633249b3d Uploaded
bgruening
parents:
diff changeset
27 <inputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
28
340633249b3d Uploaded
bgruening
parents:
diff changeset
29 <conditional name="reference_source">
340633249b3d Uploaded
bgruening
parents:
diff changeset
30 <expand macro="reference_source_selector_param" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
31 <when value="cached">
340633249b3d Uploaded
bgruening
parents:
diff changeset
32 <param name="input_variant" type="data" format="vcf" label="Input variant file" help="-V,--variant &amp;lt;variant&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
33 <param name="ref_file" type="select" label="Using reference genome" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
34 <options from_data_table="gatk2_picard_indexes">
340633249b3d Uploaded
bgruening
parents:
diff changeset
35 <filter type="data_meta" key="dbkey" ref="input_variant" column="dbkey"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
36 </options>
340633249b3d Uploaded
bgruening
parents:
diff changeset
37 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
38 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
39 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
40 <when value="history"> <!-- FIX ME!!!! -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
41 <param name="input_variant" type="data" format="vcf" label="Input variant file" help="-V,--variant &amp;lt;variant&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
42 <param name="ref_file" type="data" format="fasta" label="Using reference file" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
43 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
44 </conditional>
2
8bcc13094767 Uploaded
iuc
parents: 0
diff changeset
45 <expand macro="dbsnp_param" />
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
46
340633249b3d Uploaded
bgruening
parents:
diff changeset
47 <param name="warn_on_errors" type="boolean" checked="False" truevalue="-warnOnErrors" falsevalue="" label="instead of terminating the run at the first error, print warning messages for each error seen." help="-warnOnErrors,--warnOnErrors"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
48 <param name="do_not_validate_filtered_records" type="boolean" checked="False" truevalue="-doNotValidateFilteredRecords" falsevalue="" label="do not try to validate records that are FILTERed." help="-doNotValidateFilteredRecords,--doNotValidateFilteredRecords"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
49
340633249b3d Uploaded
bgruening
parents:
diff changeset
50 <expand macro="gatk_param_type_conditional" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
51
340633249b3d Uploaded
bgruening
parents:
diff changeset
52 </inputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
53 <outputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
54 <data format="txt" name="output_log" label="${tool.name} on ${on_string} (log)" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
55 </outputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
56 <tests>
340633249b3d Uploaded
bgruening
parents:
diff changeset
57 <test>
340633249b3d Uploaded
bgruening
parents:
diff changeset
58 <param name="reference_source_selector" value="history" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
59 <param name="ref_file" value="phiX.fasta" ftype="fasta" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
60 <param name="input_variant" value="gatk/gatk_variant_annotator/gatk_variant_annotator_out_1.vcf" ftype="vcf" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
61 <param name="dbsnp_rod_bind_type_selector" value="set_dbsnp" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
62 <param name="dbsnp_input_rod" value="gatk/fake_phiX_variant_locations.vcf" ftype="vcf" />
2
8bcc13094767 Uploaded
iuc
parents: 0
diff changeset
63 <param name="dbsnp_rod_name" value="dbsnp" />
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
64 <param name="warn_on_errors" value="True"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
65 <param name="do_not_validate_filtered_records" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
66 <param name="gatk_param_type_selector" value="basic" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
67 <output name="output_log" file="gatk/gatk_validate_variants/gatk_validate_variants_out_1.log.contains" compare="contains" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
68 </test>
340633249b3d Uploaded
bgruening
parents:
diff changeset
69 </tests>
340633249b3d Uploaded
bgruening
parents:
diff changeset
70 <help>
340633249b3d Uploaded
bgruening
parents:
diff changeset
71 **What it does**
340633249b3d Uploaded
bgruening
parents:
diff changeset
72
340633249b3d Uploaded
bgruening
parents:
diff changeset
73 Validates a variants file.
340633249b3d Uploaded
bgruening
parents:
diff changeset
74
340633249b3d Uploaded
bgruening
parents:
diff changeset
75 For more information on using the ValidateVariants module, see this `tool specific page &lt;http://www.broadinstitute.org/gatk/gatkdocs/org_broadinstitute_sting_gatk_walkers_variantutils_ValidateVariants.html&gt;`_.
340633249b3d Uploaded
bgruening
parents:
diff changeset
76
340633249b3d Uploaded
bgruening
parents:
diff changeset
77 To learn about best practices for variant detection using GATK, see this `overview &lt;http://www.broadinstitute.org/gatk/guide/topic?name=best-practices&gt;`_.
340633249b3d Uploaded
bgruening
parents:
diff changeset
78
340633249b3d Uploaded
bgruening
parents:
diff changeset
79 If you encounter errors, please view the `GATK FAQ &lt;http://www.broadinstitute.org/gatk/guide/topic?name=faqs&gt;`_.
340633249b3d Uploaded
bgruening
parents:
diff changeset
80
340633249b3d Uploaded
bgruening
parents:
diff changeset
81 ------
340633249b3d Uploaded
bgruening
parents:
diff changeset
82
340633249b3d Uploaded
bgruening
parents:
diff changeset
83 **Inputs**
340633249b3d Uploaded
bgruening
parents:
diff changeset
84
340633249b3d Uploaded
bgruening
parents:
diff changeset
85 GenomeAnalysisTK: ValidateVariants accepts variant files as input.
340633249b3d Uploaded
bgruening
parents:
diff changeset
86
340633249b3d Uploaded
bgruening
parents:
diff changeset
87
340633249b3d Uploaded
bgruening
parents:
diff changeset
88 **Outputs**
340633249b3d Uploaded
bgruening
parents:
diff changeset
89
340633249b3d Uploaded
bgruening
parents:
diff changeset
90 The output is a log of variant validation.
340633249b3d Uploaded
bgruening
parents:
diff changeset
91
340633249b3d Uploaded
bgruening
parents:
diff changeset
92
340633249b3d Uploaded
bgruening
parents:
diff changeset
93 Go `here &lt;http://www.broadinstitute.org/gatk/guide/topic?name=intro&gt;`_ for details on GATK file formats.
340633249b3d Uploaded
bgruening
parents:
diff changeset
94
340633249b3d Uploaded
bgruening
parents:
diff changeset
95 -------
340633249b3d Uploaded
bgruening
parents:
diff changeset
96
340633249b3d Uploaded
bgruening
parents:
diff changeset
97 **Settings**::
340633249b3d Uploaded
bgruening
parents:
diff changeset
98
340633249b3d Uploaded
bgruening
parents:
diff changeset
99 doNotValidateFilteredRecords should we skip validation on filtered records?
340633249b3d Uploaded
bgruening
parents:
diff changeset
100 warnOnErrors should we just emit warnings on errors instead of terminating the run?
340633249b3d Uploaded
bgruening
parents:
diff changeset
101
340633249b3d Uploaded
bgruening
parents:
diff changeset
102 @CITATION_SECTION@
340633249b3d Uploaded
bgruening
parents:
diff changeset
103 </help>
340633249b3d Uploaded
bgruening
parents:
diff changeset
104 </tool>