annotate VCFToolsStats/vcfToolsStats.xml @ 24:21d878747ac6 draft default tip

Uploaded
author dereeper
date Mon, 23 Mar 2015 05:53:20 -0400
parents 50bd37c444ac
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
21
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
1 <tool id="sniplay_vcftoolsstats" name="VCF tools Stats" version="1.0.0">
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
2
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
3 <!-- [REQUIRED] Tool description displayed after the tool name -->
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
4 <description> Various statistics from VCF using VCFtools</description>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
5
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
6 <!-- [OPTIONAL] 3rd party tools, binaries, modules... required for the tool to work -->
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
7 <requirements>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
8 <requirement type="binary">perl</requirement>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
9 <requirement type="package" version="0.1.13">VCFtools</requirement>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
10 </requirements>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
11
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
12 <!-- [OPTIONAL] Command to be executed to get the tool's version string -->
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
13 <version_command>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
14 <!--
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
15 tool_binary -v
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
16 -->
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
17 </version_command>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
18
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
19 <!-- [REQUIRED] The command to execute -->
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
20 <command interpreter="perl">
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
21 vcfToolsStats.sh $filein $fileout_label $fileout_annot $fileout_het $fileout_imiss $fileout_sum $filelog
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
22 </command>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
23
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
24 <!-- [REQUIRED] Input files and tool parameters -->
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
25 <inputs>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
26 <param name="filein" type="data" format="vcf" optional="false" label="VCF input" />
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
27 <param name="fileout_label" type="text" value="vcf_stats" optional="false" label="Output file basename"/>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
28 </inputs>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
29
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
30 <!-- [REQUIRED] Output files -->
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
31 <outputs>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
32 <data name="fileout_annot" format="txt" label="${fileout_label}.annotation" />
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
33 <data name="fileout_het" format="txt" label="${fileout_label}.het" />
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
34 <data name="fileout_imiss" format="txt" label="${fileout_label}.imiss" />
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
35 <data name="fileout_sum" format="txt" label="${fileout_label}.TsTv.summary" />
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
36 <data name="filelog" format="txt" label="${fileout_label}.log" />
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
37 </outputs>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
38
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
39 <!-- [STRONGLY RECOMMANDED] Exit code rules -->
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
40 <stdio>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
41 <!-- [HELP] If no exit code rule is defined, the tool will stop if anything is written to STDERR -->
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
42 <exit_code range="1:" level="fatal" />
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
43 </stdio>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
44
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
45 <!-- [OPTIONAL] Tests to be run manually by the Galaxy admin -->
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
46 <tests>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
47 <!-- [HELP] Test files have to be in the ~/test-data directory -->
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
48 <test>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
49 <param name="filein" value="sample.vcf" />
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
50 <output name="fileout_annot" file="result.annotation" />
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
51 <output name="fileout_het" file="result.het" />
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
52 <output name="fileout_imiss" file="result.imiss" />
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
53 <output name="fileout_sum" file="result.TsTv.summary" />
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
54 <output name="filelog" file="result.log" />
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
55 </test>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
56 </tests>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
57
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
58 <!-- [OPTIONAL] Help displayed in Galaxy -->
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
59 <help>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
60
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
61 .. class:: infomark
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
62
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
63 **Authors**
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
64
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
65 ---------------------------------------------------
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
66
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
67 .. class:: infomark
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
68
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
69 **Please cite** If you use this tool, please cite Dereeper et al. 2015 in prep.
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
70
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
71 ---------------------------------------------------
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
72
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
73 ================
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
74 VCF tools filter
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
75 ================
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
76
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
77 -----------
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
78 Description
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
79 -----------
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
80
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
81 Compute statistics on VCF file
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
82
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
83 -----------------
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
84 Workflow position
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
85 -----------------
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
86
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
87 **Upstream tools**
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
88
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
89 =========== ========================== =======
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
90 Name output file(s) format
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
91 =========== ========================== =======
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
92 =========== ========================== =======
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
93
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
94
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
95 **Downstream tools**
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
96
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
97 =========== ========================== =======
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
98 Name output file(s) format
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
99 =========== ========================== =======
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
100 =========== ========================== =======
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
101
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
102
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
103 ----------
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
104 Input file
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
105 ----------
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
106
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
107 VCF file
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
108 VCF file with all SNPs
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
109
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
110 ----------
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
111 Parameters
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
112 ----------
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
113
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
114 Output file basename
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
115 Prefix for the output VCF file
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
116
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
117 ------------
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
118 Output files
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
119 ------------
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
120
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
121 .annotation file
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
122 Statistics on annotation/location along genome
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
123
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
124 .het file
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
125 Statistics on heterozygosity of the individuals
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
126
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
127 .imiss
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
128 Statistics on missing data of the inidividuals
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
129 .TsTv.summary
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
130 Statistics on mutation types and transition/transvertion number
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
131
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
132 .log file
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
133
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
134 ---------------------------------------------------
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
135
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
136 ---------------
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
137 Working example
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
138 ---------------
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
139
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
140 Input files
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
141 ===========
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
142
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
143 VCF file
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
144 ---------
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
145
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
146 ::
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
147
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
148 #fileformat=VCFv4.1
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
149 #FILTER=&lt;ID=LowQual,Description="Low quality">
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
150 #FORMAT=&lt;ID=AD,Number=.,Type=Integer,Description="Allelic depths for the ref and alt alleles in the order listed">
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
151 [...]
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
152 CHROM POS ID REF ALT QUAL FILTER INFO FORMAT CATB1
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
153 chr1 2209 . G T 213.84 . AC=2;AF=1.00;AN=2;DP=7;Dels=0.00;FS=0.000;HaplotypeScore=0.0000;MLEAC=2;MLEAF=1.00;MQ=41.50;MQ0=0;QD=30.55;EFF=DOWNSTREAM(MODIFIER||||Cc01g00020|mRNA||GSCOCT00012438001|),UPSTREAM(MODIFIER||||Cc01g00010|mRNA||GSCOCT00012439001|) GT:AD:DP:GQ:PL 1/1:0,7:7:18:242,18,0
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
154
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
155
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
156 Parameters
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
157 ==========
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
158
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
159 Output name -> vcf_stat
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
160
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
161
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
162 Output files
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
163 ============
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
164
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
165 .annotation file
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
166 ----------------
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
167
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
168 ::
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
169
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
170 Genic 4489
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
171 Intergenic 466
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
172 ========
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
173 Intron 960
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
174 Exon 3248
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
175 UTR 281
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
176 ========
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
177 Non-syn 226
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
178 Synonym 3022
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
179
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
180 .het file
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
181 ---------
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
182
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
183 ::
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
184
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
185 INDV O(HOM) E(HOM) N_SITES F
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
186 CATB1 0 0.0 3616 0.00000
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
187
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
188 .imiss file
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
189 -----------
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
190
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
191 ::
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
192
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
193 INDV N_DATA N_GENOTYPES_FILTERED N_MISS F_MISS
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
194 CATB1 4813 0 0 0
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
195
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
196 .TsTv.summary file
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
197 ------------------
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
198
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
199 ::
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
200
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
201 MODEL COUNT
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
202 AC 371
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
203 AG 1467
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
204 AT 562
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
205 CG 330
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
206 CT 1659
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
207 GT 397
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
208 Ts 3126
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
209 Tv 1660
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
210
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
211
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
212 </help>
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
213
50bd37c444ac Uploaded
dereeper
parents:
diff changeset
214 </tool>