annotate MDSplot/mdsplot.xml @ 24:21d878747ac6 draft default tip

Uploaded
author dereeper
date Mon, 23 Mar 2015 05:53:20 -0400
parents a0a95688cf17
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
1 <tool id="sniplay_mdsplot" name="MDS plot" version="1.1.1">
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
2
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
3 <!-- [REQUIRED] Tool description displayed after the tool name -->
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
4 <description> IBS matrix / multi-dimensional scaling</description>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
5
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
6 <!-- [OPTIONAL] 3rd party tools, binaries, modules... required for the tool to work -->
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
7 <requirements>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
8 <requirement type="binary">perl</requirement>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
9 <requirement type="package" version="0.1.13">plink</requirement>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
10 </requirements>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
11
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
12 <!-- [OPTIONAL] Command to be executed to get the tool's version string -->
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
13 <version_command>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
14 <!--
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
15 tool_binary -v
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
16 -->
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
17 </version_command>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
18
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
19 <!-- [REQUIRED] The command to execute -->
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
20 <command interpreter="bash">
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
21 mdsplot.sh $fileped $filemap $fileout_label $fileout_matrix $fileout_plot $fileout_log
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
22 </command>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
23
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
24 <!-- [REQUIRED] Input files and tool parameters -->
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
25 <inputs>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
26 <param name="fileped" type="data" format="txt" optional="false" label="PED input" />
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
27 <param name="filemap" type="data" format="txt" optional="false" label="MAP input" help="4 columns tabular file: chromosome, snp id, genetic distance, bp position"/>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
28 <param name="fileout_label" type="text" value="analyse" label="Output name" help="Output name for tabular files" />
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
29 </inputs>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
30
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
31 <!-- [REQUIRED] Output files -->
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
32 <outputs>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
33 <data name="fileout_matrix" type="data" format="tabular" label="${fileout_label}.ibs_matrix.txt" />
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
34 <data name="fileout_plot" type="data" format="tabular" label="${fileout_label}.mds_plot.txt" />
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
35 <data name="fileout_log" type="data" format="txt" label="${fileout_label}.log" />
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
36 </outputs>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
37
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
38 <!-- [STRONGLY RECOMMANDED] Exit code rules -->
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
39 <stdio>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
40 <!-- [HELP] If no exit code rule is defined, the tool will stop if anything is written to STDERR -->
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
41 <exit_code range="1:" level="fatal" />
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
42 </stdio>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
43
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
44 <!-- [OPTIONAL] Tests to be run manually by the Galaxy admin -->
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
45 <tests>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
46 <!-- [HELP] Test files have to be in the ~/test-data directory -->
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
47
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
48 <test>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
49 <param name="fileped" value="input.ped" />
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
50 <param name="filemap" value="input.map" />
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
51 <output name="fileout_matrix" file="output.ibs_matrix.txt" />
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
52 <output name="fileout_plot" file="output.mds_plot.txt" />
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
53 <output name="fileout_log" file="output.log" />
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
54 </test>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
55
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
56 <!-- [HELP] Multiple tests can be defined with different parameters -->
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
57 <!--
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
58 <test>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
59 </test>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
60 -->
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
61 </tests>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
62
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
63 <!-- [OPTIONAL] Help displayed in Galaxy -->
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
64 <help>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
65
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
66 .. class:: infomark
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
67
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
68 **Authors**
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
69
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
70 ---------------------------------------------------
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
71
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
72 .. class:: infomark
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
73
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
74 **Please cite** If you use this tool, please cite dereeper et al. 2015 in prep.
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
75
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
76 ---------------------------------------------------
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
77
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
78 ========
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
79 MDS plot
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
80 ========
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
81
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
82 -----------
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
83 Description
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
84 -----------
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
85
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
86 Compute an IBS matrix and a multi-dimensional scaling.
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
87
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
88
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
89 -----------------
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
90 Workflow position
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
91 -----------------
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
92
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
93 **Upstream tools**
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
94
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
95 =========== ========================== =======
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
96 Name output file(s) format
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
97 =========== ========================== =======
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
98 =========== ========================== =======
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
99
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
100
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
101 **Downstream tools**
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
102
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
103 =========== ========================== =======
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
104 Name output file(s) format
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
105 =========== ========================== =======
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
106 =========== ========================== =======
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
107
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
108
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
109 ----------
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
110 Input file
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
111 ----------
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
112
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
113 PED file
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
114
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
115 MAP file
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
116 4 columns tabular file: chromosome, snp id, genetic distance, bp position
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
117
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
118
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
119 ----------
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
120 Parameters
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
121 ----------
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
122
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
123 Output name
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
124 Output base name for the ouput files
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
125
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
126
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
127 ------------
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
128 Output files
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
129 ------------
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
130
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
131 Output_name.ibs_matrix.txt
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
132 Tabular file with IBS matrix
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
133
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
134 Output_name.mds_plot.txt
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
135 File to construct mds plot
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
136
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
137 Output_name.log
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
138 Log file
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
139
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
140
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
141 ---------------------------------------------------
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
142
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
143 ---------------
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
144 Working example
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
145 ---------------
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
146
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
147 Input files
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
148 ===========
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
149
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
150 PED file
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
151 -----------
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
152
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
153 ::
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
154
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
155 IRAT112 1 0 0 1 1 1 1 4 4 ...
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
156 IAC25 1 0 0 1 1 1 1 4 4 ...
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
157 CIRAD409 1 0 0 1 1 3 3 1 1 ...
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
158
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
159
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
160 MAP file
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
161 -----------
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
162
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
163 ::
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
164
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
165 Chr1 Chr1:4299 0 4299
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
166 Chr1 Chr1:26710 0 26710
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
167 Chr1 Chr1:56184 0 56184
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
168 Chr1 Chr1:93272 0 93272
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
169
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
170
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
171
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
172 Parameters
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
173 ==========
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
174
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
175 Output name -> densities
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
176
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
177
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
178 Output files
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
179 ============
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
180
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
181 densities.ibs_matrix.txt
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
182 ------------------------
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
183
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
184 ::
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
185
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
186 Individuals IRAT112 IAC25 IAC165 KARASUKARASURANKASU DOURADOPRECOCE ...
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
187 IRAT112 1 0.93691 0.937407 0.734724 0.943368 ...
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
188 IAC25 0.93691 1 0.958768 0.723299 0.965723 ...
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
189
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
190
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
191 densities.mds_plot.txt
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
192 ----------------------
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
193
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
194 ::
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
195
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
196 IRAT112 -0.0969382 0.0376036
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
197 IAC25 -0.0918126 0.0501177
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
198
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
199
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
200
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
201 </help>
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
202
a0a95688cf17 Uploaded
dereeper
parents:
diff changeset
203 </tool>