annotate VCFToolsStats/.svn/text-base/vcfToolsStats.xml.svn-base @ 11:f494c8d22725 draft default tip

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