annotate abims_CAMERA_combinexsAnnos.xml @ 2:46e8eb12f47b draft

Uploaded
author mmonsoor
date Thu, 17 Dec 2015 09:12:40 -0500
parents 0c730c636867
children 4ca5c7bbc6cf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
1 <tool id="abims_CAMERA_combinexsAnnos" name="CAMERA.combinexsAnnos" version="2.0.1">
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
2
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
3 <description>Wrapper function for the combinexsAnnos CAMERA function. Returns a dataframe with recalculated annotations.</description>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
4
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
5 <requirements>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
6 <requirement type="package" version="3.1.2">R</requirement>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
7 <requirement type="binary">Rscript</requirement>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
8 <requirement type="package" version="1.44.0">xcms</requirement>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
9 <requirement type="package" version="1.22.0">camera</requirement>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
10 <requirement type="package" version="2.1">camera_w4m_script</requirement>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
11 </requirements>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
12
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
13 <stdio>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
14 <exit_code range="1:" level="fatal" />
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
15 </stdio>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
16
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
17 <command>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
18 CAMERA.r
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
19 xfunction combinexsAnnos image_pos $image_pos image_neg $image_neg
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
20 pos $pos tol $tol ruleset $ruleset convert_param $convert_param keep_meta $keep_meta &amp;&amp; (
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
21 mv variableMetadata.tsv $variableMetadata);
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
22 cat xset.log
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
23 </command>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
24
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
25 <inputs>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
26 <param name="image_pos" type="data" label="Positive RData ion mode" format="rdata.camera.positive,rdata" help="output file from CAMERA.annotate using a positive polarity mode" />
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
27 <param name="image_neg" type="data" label="Negative RData ion mode" format="rdata.camera.negative,rdata" help="output file from CAMERA.annotate using a positive negative mode" />
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
28
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
29 <param name="pos" type="select" label="Returned peaklist polarity mode">
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
30 <option value="TRUE" selected="true">positive</option>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
31 <option value="FALSE" >negative</option>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
32 </param>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
33
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
34 <param name="tol" type="integer" value="2" label="Retention time window in seconds" help="[pos] As first step it searches for pseudospectra from the positive and the negative sample within a retention time window" />
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
35 <param name="ruleset" type="text" value="1,1" label="Matrix of matching rules" help="[ruleset] Matrix of matching rules. By default, the matrix (1,1) would create the M+H/M-H rule, since the first rule of xsa.pos@ruleset and xsa.neg@ruleset is M+H respectively M-H. Only rules with identical charge can be combined!" />
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
36 <param name="convert_param" type="boolean" checked="false" truevalue="TRUE" falsevalue="FALSE" label="Convert retention time (seconds) rtmed, rtmin and rtmax into minutes"/>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
37 <param name="keep_meta" type="boolean" checked="true" truevalue="TRUE" falsevalue="FALSE" label="Keep only the metabolites which match a difference "/>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
38
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
39 </inputs>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
40
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
41 <outputs>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
42 <data name="variableMetadata" format="tabular" label="${image_pos.name[:-6]}.combinexsAnnos.variableMetadata.tsv" />
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
43 <!--
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
44 <data name="rdata" format="rdata" label="${image_pos.name[:-6]}.combinexsAnnos.Rdata" />
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
45 -->
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
46 </outputs>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
47
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
48 <tests>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
49 <test>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
50 <!-- TODO: generer des vrais dataset pos et neg-->
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
51 <param name="image_pos" value="xset.group.retcor.group.fillPeaks.annotate.positive.Rdata"/>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
52 <param name="image_neg" value="xset.group.retcor.group.fillPeaks.annotate.negative.Rdata"/>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
53 <param name="pos" value="TRUE"/>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
54 <param name="tol" value="2"/>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
55 <param name="ruleset" value="1,1"/>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
56 <output name="variableMetadata" file="xset.group.retcor.group.fillPeaks.annotate.positive.combinexsAnnos.variableMetadata.tsv" />
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
57 </test>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
58 </tests>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
59
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
60
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
61 <help>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
62
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
63 .. class:: infomark
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
64
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
65 **Authors** Carsten Kuhl ckuhl@ipb-halle.de, Ralf Tautenhahn rtautenh@scripps.edu, Steffen Neumann sneumann@@ipb-halle.de
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
66
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
67 .. class:: infomark
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
68
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
69 **Galaxy integration** ABiMS TEAM - UPMC/CNRS - Station biologique de Roscoff and Yann Guitton yann.guitton@univ-nantes.fr - part of Workflow4Metabolomics.org [W4M]
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
70
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
71 | Contact support@workflow4metabolomics.org for any questions or concerns about the Galaxy implementation of this tool.
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
72
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
73 ---------------------------------------------------
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
74
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
75
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
76
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
77 =======================
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
78 Xcms.combinexsAnnos
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
79 =======================
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
80
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
81 -----------
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
82 Description
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
83 -----------
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
84
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
85 **What it does?**
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
86
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
87 This function check annotations of ion species with the help of a sample from opposite ion mode.
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
88 As first step it searches for pseudospectra from the positive and the negative sample within a reten-
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
89 tion time window. For every result the m/z differences between both samples are matched against
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
90 specific rules, which are combinations from pos. and neg. ion species. As example M+H and M-H
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
91 with a m/z difference of 2.014552. If two ions matches such a difference, the ion annotations are
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
92 changed (previous annotation is wrong), confirmed or added. Returns the peaklist from one ion
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
93 mode with recalculated annotations.
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
94
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
95 **Details**
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
96
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
97 Both xsAnnotate object should be full processed (grouping and annotation). Without previous anno-
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
98 tation the resulting peaklist only includes annotation with matches peaks from both mode according
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
99 to the rule(s). With ruleset=NULL the function only looks for M+H/M-H pairs. The ruleset is
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
100 a two column matrix with includes rule indices from the rule table of both xsAnnotate objects.
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
101 A ruleset (1,1) would create the M+H/M-H rule, since the first rule of xsa.pos@ruleset and
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
102 xsa.neg@ruleset is M+H respectively M-H. Only rules with identical charge can be combined!
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
103
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
104
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
105
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
106 -----------------
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
107 Workflow position
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
108 -----------------
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
109
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
110
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
111 **Upstream tools**
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
112
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
113 ========================= ======================= ===================== ==========
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
114 Name Output file Format Parameter
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
115 ========================= ======================= ===================== ==========
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
116 xcms.annotatediffreport xset.annotate_POS.RData rdata.camera.positive RData file
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
117 ------------------------- ----------------------- --------------------- ----------
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
118 xcms.annotatediffreport xset.annotate_NEG.RData rdata.camera.positive RData file
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
119 ========================= ======================= ===================== ==========
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
120
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
121 **Downstream tools**
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
122
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
123 +---------------------------+-----------------------------------------+--------+
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
124 | Name | Output file | Format |
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
125 +===========================+=========================================+========+
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
126 |Batch_correction |xset.combinexsAnnos.variableMetadata.tsv | Tabular|
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
127 +---------------------------+-----------------------------------------+--------+
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
128 |Filters |xset.combinexsAnnos.variableMetadata.tsv | Tabular|
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
129 +---------------------------+-----------------------------------------+--------+
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
130 |Univariate |xset.combinexsAnnos.variableMetadata.tsv | Tabular|
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
131 +---------------------------+-----------------------------------------+--------+
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
132 |Multivariate |xset.combinexsAnnos.variableMetadata.tsv | Tabular|
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
133 +---------------------------+-----------------------------------------+--------+
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
134
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
135
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
136
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
137 The output file **xset.annotateDiffreport.variableMetadata.tsv** is a tabular file. You can continue your analysis using it in the following tools:
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
138 | Batch_correction
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
139 | Filters
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
140 | Univariate
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
141 | Multivariate PCA, PLS and OPLS
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
142
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
143
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
144 **General schema of the metabolomic workflow**
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
145
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
146 .. image:: combinexsannos_workflow.png
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
147
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
148
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
149 -----------
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
150 Input files
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
151 -----------
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
152
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
153 +---------------------------+----------------------------+
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
154 | Parameter : label | Format |
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
155 +===========================+============================+
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
156 | Positive RData ion mode | rdata.camera.positive |
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
157 +---------------------------+----------------------------+
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
158 | Negative RData ion mode | rdata.camera.negative |
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
159 +---------------------------+----------------------------+
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
160
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
161 ------------
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
162 Output files
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
163 ------------
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
164
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
165 xset.combinexsAnnos.variableMetadata.tsv
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
166
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
167 | A tabular file which is similar to the diffreport result , within additional columns containing the annotation results.
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
168 | For each metabolite (row) :
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
169 | the value of the intensity in each sample, fold, tstat, pvalue, anova, mzmed, mzmin, mzmax, rtmed, rtmin, rtmax, npeaks, isotopes, adduct, pcgroup and neg (or pos). Mode
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
170
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
171 xset.combinexsAnnos.Rdata
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
172
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
173 | Rdata file, that be used outside Galaxy in R.
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
174
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
175
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
176 ---------------------------------------------------
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
177
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
178 ---------------
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
179 Working example
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
180 ---------------
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
181
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
182 Input files
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
183 -----------
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
184
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
185 | Positive RData ion mode -> **POS.xset.annotateDiffreport.RData**
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
186 | Negative RData ion mode -> **NEG.xset.annotateDiffreport.RData**
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
187
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
188 Parameters
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
189 ----------
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
190
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
191 | pos -> **positive**
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
192 | tol -> **2 (default)**
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
193 | ruleset -> **1,1 (default)**
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
194
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
195 Output files
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
196 ------------
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
197
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
198 **Example of an xset.combinexsAnnos.variableMetadata.tsv output:**
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
199
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
200 .. image:: combinexsannos_variableMetadata.png
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
201
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
202 </help>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
203
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
204 <citations>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
205 <citation type="doi"> 10.1021/ac202450g</citation>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
206 <citation type="doi">10.1093/bioinformatics/btu813</citation>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
207 </citations>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
208
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
209
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
210 </tool>
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
211
0c730c636867 planemo upload
mmonsoor
parents:
diff changeset
212