annotate MDSplot/mdsplot.xml @ 5:ec22fcacb66c draft

planemo upload
author gandres
date Mon, 15 Feb 2016 10:26:18 -0500
parents 10627af23f10
children 6bf69b40365c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
ec22fcacb66c planemo upload
gandres
parents: 4
diff changeset
1 <tool id="sniplay_mdsplot" name="MDS plot" version="1.2.0">
3
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
2
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
3 <!-- [REQUIRED] Tool description displayed after the tool name -->
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
4 <description> IBS matrix / multi-dimensional scaling</description>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
5
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
6 <!-- [OPTIONAL] 3rd party tools, binaries, modules... required for the tool to work -->
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
7 <requirements>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
8 <requirement type="binary">perl</requirement>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
9 <requirement type="package" version="1.07">plink</requirement>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
10 </requirements>
4
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
11
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
12 <!-- [STRONGLY RECOMMANDED] Exit code rules -->
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
13 <stdio>
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
14 <!-- [HELP] If no exit code rule is defined, the tool will stop if anything is written to STDERR -->
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
15 <exit_code range="1:" level="fatal" />
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
16 </stdio>
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
17
3
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
18
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
19 <!-- [OPTIONAL] Command to be executed to get the tool's version string -->
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
20 <version_command>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
21 <!--
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
22 tool_binary -v
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
23 -->
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
24 </version_command>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
25
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
26 <!-- [REQUIRED] The command to execute -->
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
27 <command interpreter="bash">
4
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
28 mdsplot.sh $fileped $filemap $fileout_matrix $fileout_plot $fileout_log
3
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
29 </command>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
30
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
31 <!-- [REQUIRED] Input files and tool parameters -->
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
32 <inputs>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
33 <param name="fileped" type="data" format="txt" optional="false" label="PED input" />
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
34 <param name="filemap" type="data" format="txt" optional="false" label="MAP input" help="4 columns tabular file: chromosome, snp id, genetic distance, bp position"/>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
35 <param name="fileout_label" type="text" value="analyse" label="Output name" help="Output name for tabular files" />
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
36 </inputs>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
37
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
38 <!-- [REQUIRED] Output files -->
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
39 <outputs>
5
ec22fcacb66c planemo upload
gandres
parents: 4
diff changeset
40 <data name="fileout_matrix" type="data" format="txt" label="${fileout_label}.ibs_matrix.txt" />
ec22fcacb66c planemo upload
gandres
parents: 4
diff changeset
41 <data name="fileout_plot" type="data" format="txt" label="${fileout_label}.mds_plot.txt" />
3
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
42 <data name="fileout_log" type="data" format="txt" label="${fileout_label}.log" />
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
43 </outputs>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
44
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
45 <!-- [OPTIONAL] Tests to be run manually by the Galaxy admin -->
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
46 <tests>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
47 <!-- [HELP] Test files have to be in the ~/test-data directory -->
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
48
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
49 <test>
4
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
50 <param name="fileped" value="MDSplot-input.ped" />
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
51 <param name="filemap" value="MDSplot-input.map" />
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
52 <output name="fileout_matrix" file="MDSplot-output.ibs_matrix.txt" />
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
53 <output name="fileout_plot" file="MDSplot-output.mds_plot.txt" />
3
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
54 </test>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
55
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
56 <!-- [HELP] Multiple tests can be defined with different parameters -->
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
57 <!--
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
58 <test>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
59 </test>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
60 -->
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
61 </tests>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
62
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
63 <!-- [OPTIONAL] Help displayed in Galaxy -->
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
64 <help>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
65
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
66
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
67 .. class:: infomark
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
68
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
69 **Authors** plink_
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
70
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
71 .. _plink: http://pngu.mgh.harvard.edu/purcell/plink/
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
72
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
73 | "PLINK: a toolset for whole-genome association and population-based linkage analysis.", **Purcell S, Neale B, Todd-Brown K, Thomas L, Ferreira MAR, Bender D, Maller J, Sklar P, de Bakker PIW, Daly MJ, Sham PC.**, American Journal of Human Genetics, 81, 2007.
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
74
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
75
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
76 .. class:: infomark
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
77
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
78 **Galaxy integration** Andres Gwendoline, Institut Français de Bioinformatique.
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
79
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
80 .. class:: infomark
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
81
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
82 **Support** For any questions about Galaxy integration, please send an e-mail to support.abims@sb-roscoff.fr
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
83
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
84 .. class:: infomark
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
85
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
86 **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).
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
87
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
88 ---------------------------------------------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
89
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
90
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
91
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
92 ========
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
93 MDS plot
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
94 ========
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
95
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
96 -----------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
97 Description
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
98 -----------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
99
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
100 Compute an IBS matrix and a multi-dimensional scaling.
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
101
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
102
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
103 -----------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
104 Workflow position
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
105 -----------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
106
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
107 **Upstream tool**
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
108
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
109 =============== ========================== ===============
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
110 Name output file(s) format
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
111 =============== ========================== ===============
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
112 VCFtools Filter PED and MAP file tabular and MAP
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
113 =============== ========================== ===============
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
114
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
115
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
116
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
117 ----------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
118 Input file
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
119 ----------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
120
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
121 PED file
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
122
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
123 MAP file
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
124 4 columns tabular file: chromosome, snp id, genetic distance, bp position
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
125
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
126
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
127 ----------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
128 Parameters
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
129 ----------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
130
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
131 Output name
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
132 Output base name for the ouput files
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
133
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
134
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
135 ------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
136 Output files
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
137 ------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
138
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
139 Output_name.ibs_matrix.txt
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
140 Tabular file with IBS matrix
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
141
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
142 Output_name.mds_plot.txt
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
143 File to construct mds plot
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
144
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
145 Output_name.log
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
146 Log file
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
147
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
148 ------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
149 Dependencies
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
150 ------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
151 plink
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
152 version 1.07
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
153
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
154 ---------------------------------------------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
155
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
156 ---------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
157 Working example
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
158 ---------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
159
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
160 Input files
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
161 ===========
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
162
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
163 PED file
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
164 -----------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
165
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
166 ::
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
167
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
168 IRAT112 1 0 0 1 1 1 1 4 4 ...
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
169 IAC25 1 0 0 1 1 1 1 4 4 ...
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
170 CIRAD409 1 0 0 1 1 3 3 1 1 ...
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
171
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
172
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
173 MAP file
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
174 -----------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
175
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
176 ::
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
177
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
178 Chr1 Chr1:4299 0 4299
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
179 Chr1 Chr1:26710 0 26710
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
180 Chr1 Chr1:56184 0 56184
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
181 Chr1 Chr1:93272 0 93272
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
182
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
183
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
184
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
185 Parameters
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
186 ==========
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
187
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
188 Output name -> densities
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
189
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
190
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
191 Output files
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
192 ============
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
193
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
194 densities.ibs_matrix.txt
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
195 ------------------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
196
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
197 ::
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
198
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
199 Individuals IRAT112 IAC25 IAC165 KARASUKARASURANKASU DOURADOPRECOCE ...
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
200 IRAT112 1 0.93691 0.937407 0.734724 0.943368 ...
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
201 IAC25 0.93691 1 0.958768 0.723299 0.965723 ...
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
202
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
203
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
204 densities.mds_plot.txt
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
205 ----------------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
206
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
207 ::
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
208
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
209 IRAT112 -0.0969382 0.0376036
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
210 IAC25 -0.0918126 0.0501177
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
211
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
212
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
213
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
214 </help>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
215 <citations>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
216 <!-- [HELP] As DOI or BibTex entry -->
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
217 <citation type="bibtex">@article{Dereeper03062015,
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
218 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},
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
219 title = {SNiPlay3: a web-based application for exploration and large scale analyses of genomic variations},
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
220 year = {2015},
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
221 doi = {10.1093/nar/gkv351},
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
222 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.},
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
223 URL = {http://nar.oxfordjournals.org/content/early/2015/06/03/nar.gkv351.abstract},
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
224 eprint = {http://nar.oxfordjournals.org/content/early/2015/06/03/nar.gkv351.full.pdf+html},
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
225 journal = {Nucleic Acids Research}
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
226 }
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
227
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
228 </citation>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
229
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
230 </citations>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
231
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
232 </tool>