annotate SNP_density/calculateSlidingWindowsSNPdensitiesFromVCF_wrapper.xml @ 6:ebb0ac9b6fa9 draft

planemo upload
author gandres
date Mon, 23 May 2016 17:49:17 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
1 <tool id="sniplay_density" name="SNP density" version="2.0.0">
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
2
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
3 <!-- [REQUIRED] Tool description displayed after the tool name -->
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
4 <description> Calculate SNP densities along chromosome from a VCF input</description>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
5
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
6 <!-- [OPTIONAL] 3rd party tools, binaries, modules... required for the tool to work -->
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
7 <requirements>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
8 <requirement type="binary">perl</requirement>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
9 <requirement type="package" version="0.1.12b">vcftools</requirement>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
10 </requirements>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
11
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
12 <!-- [STRONGLY RECOMMANDED] Exit code rules -->
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
13 <stdio>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
14 <!-- [HELP] If no exit code rule is defined, the tool will stop if anything is written to STDERR -->
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
15 <exit_code range="1:" level="fatal" />
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
16 </stdio>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
17
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
18 <!-- [OPTIONAL] Command to be executed to get the tool's version string -->
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
19 <version_command>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
20 <!--
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
21 tool_binary -v
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
22 -->
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
23 </version_command>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
24
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
25 <!-- [REQUIRED] The command to execute -->
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
26 <command interpreter="bash">
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
27 calculateSlidingWindowsSNPdensitiesFromVCF.sh $filein $fileout $fileout_bysample $step
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
28 </command>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
29
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
30 <!-- [REQUIRED] Input files and tool parameters -->
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
31 <inputs>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
32 <param name="filein" type="data" format="vcf" optional="false" label="VCF input" />
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
33 <param name="step" type="integer" value="200000" label="Step" help="Step in bp"/>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
34 <param name="fileout_label" type="text" value="densities" label="Output name" help="Output name for tabular files" />
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
35 </inputs>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
36
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
37 <!-- [REQUIRED] Output files -->
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
38 <outputs>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
39 <data name="fileout" type="data" format="txt" label="${fileout_label}" />
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
40 <data name="fileout_bysample" type="data" format="txt" label="${fileout_label}.by_sample" />
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
41 </outputs>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
42
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
43 <tests>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
44 <test>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
45 <param name="filein" value="vcf2fastaAndHapmap-sample.vcf" />
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
46 <param name="step" value="20000" />
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
47 <output name="fileout" file="SNPden-result.txt" />
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
48 <output name="fileout_bysample" file="SNPden-result_bysample.txt" />
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
49 </test>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
50 <!-- [HELP] Multiple tests can be defined with different parameters -->
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
51 <!--
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
52 <test>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
53 </test>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
54 -->
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
55 </tests>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
56
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
57 <!-- [OPTIONAL] Help displayed in Galaxy -->
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
58 <help>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
59
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
60 .. class:: infomark
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
61
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
62 **Authors** Dereeper Alexis (alexis.dereeper@ird.fr), IRD, South Green platform
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
63
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
64 | **Please cite** "SNiPlay3: a web-based application for exploration and large scale analyses of genomic variations", **Dereeper A. et al.**, Nucl. Acids Res. (1 july 2015) 43 (W1).
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
65
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
66
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
67 .. class:: infomark
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
68
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
69 **Galaxy integration** Andres Gwendoline, Institut Français de Bioinformatique.
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
70
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
71 .. class:: infomark
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
72
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
73 **Support** For any questions about Galaxy integration, please send an e-mail to support.abims@sb-roscoff.fr
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
74
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
75 ---------------------------------------------------
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
76
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
77
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
78
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
79 =============
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
80 SNP densities
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
81 =============
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
82
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
83 -----------
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
84 Description
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
85 -----------
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
86
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
87 Calculate SNP densities along chromosome from a VCF file
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
88
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
89
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
90 -----------------
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
91 Workflow position
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
92 -----------------
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
93
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
94 **Upstream tool**
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
95
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
96 =============== ====================== ===========
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
97 Name output file(s) format
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
98 =============== ====================== ===========
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
99 =============== ====================== ===========
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
100
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
101
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
102 ----------
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
103 Input file
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
104 ----------
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
105
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
106 VCF file
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
107 File with SNPs
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
108
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
109
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
110 ----------
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
111 Parameters
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
112 ----------
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
113
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
114 Step
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
115 Step in bp for the window to calculate SNP density
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
116
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
117 Output name
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
118 Output base name for the two ouput files
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
119
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
120
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
121 ------------
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
122 Output files
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
123 ------------
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
124
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
125 Output_name
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
126 Tabular file with SNP density in each postion
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
127
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
128 Output_name.by_sample
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
129 Tabular file with SNP density for each sample
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
130
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
131
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
132 ---------------------------------------------------
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
133
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
134 ---------------
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
135 Working example
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
136 ---------------
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
137
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
138 Input files
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
139 ===========
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
140
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
141 vcf file
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
142 -----------
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
143
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
144 ::
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
145
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
146 #fileformat=VCFv4.1
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
147 #FILTER=&lt;ID=LowQual,Description="Low quality">
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
148 #FORMAT=&lt;ID=AD,Number=.,Type=Integer,Description="Allelic depths for the ref and alt alleles in the order listed">
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
149 [...]
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
150 CHROM POS ID REF ALT QUAL FILTER INFO FORMAT CATB1
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
151 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
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
152
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
153 Parameters
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
154 ==========
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
155
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
156 Step -> 200000
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
157
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
158 Output name -> densities
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
159
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
160
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
161 Output files
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
162 ============
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
163
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
164 densities
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
165 ---------
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
166
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
167 ::
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
168
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
169 Chromosome Position SNPs
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
170 chr1 200000 355
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
171 chr1 400000 228
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
172 chr1 600000 63
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
173 chr1 800000 191
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
174
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
175
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
176 densities.by_sample
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
177 -------------------
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
178
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
179 ::
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
180
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
181 Chromosome BA58 BA59 BD54
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
182 chr1 220 197 225
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
183 chr1 130 119 133
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
184 chr1 43 43 40
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
185 chr1 139 167 141
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
186
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
187 </help>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
188 <citations>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
189 <!-- [HELP] As DOI or BibTex entry -->
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
190 <citation type="bibtex">@article{Dereeper03062015,
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
191 author = {Dereeper, Alexis and Homa, Felix and Andres, Gwendoline and Sempere, Guilhem and Sarah, Gautier and Hueber, Yann and Dufayard, Jean-François and Ruiz, Manuel},
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
192 title = {SNiPlay3: a web-based application for exploration and large scale analyses of genomic variations},
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
193 year = {2015},
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
194 doi = {10.1093/nar/gkv351},
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
195 abstract ={SNiPlay is a web-based tool for detection, management and analysis of genetic variants including both single nucleotide polymorphisms (SNPs) and InDels. Version 3 now extends functionalities in order to easily manage and exploit SNPs derived from next generation sequencing technologies, such as GBS (genotyping by sequencing), WGRS (whole gre-sequencing) and RNA-Seq technologies. Based on the standard VCF (variant call format) format, the application offers an intuitive interface for filtering and comparing polymorphisms using user-defined sets of individuals and then establishing a reliable genotyping data matrix for further analyses. Namely, in addition to the various scaled-up analyses allowed by the application (genomic annotation of SNP, diversity analysis, haplotype reconstruction and network, linkage disequilibrium), SNiPlay3 proposes new modules for GWAS (genome-wide association studies), population stratification, distance tree analysis and visualization of SNP density. Additionally, we developed a suite of Galaxy wrappers for each step of the SNiPlay3 process, so that the complete pipeline can also be deployed on a Galaxy instance using the Galaxy ToolShed procedure and then be computed as a Galaxy workflow. SNiPlay is accessible at http://sniplay.southgreen.fr.},
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
196 URL = {http://nar.oxfordjournals.org/content/early/2015/06/03/nar.gkv351.abstract},
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
197 eprint = {http://nar.oxfordjournals.org/content/early/2015/06/03/nar.gkv351.full.pdf+html},
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
198 journal = {Nucleic Acids Research}
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
199 }
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
200
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
201 </citation>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
202
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
203 </citations>
ebb0ac9b6fa9 planemo upload
gandres
parents:
diff changeset
204 </tool>