annotate abims_CAMERA_annotateDiffreport.xml @ 6:b1ce440044a8 draft

Uploaded
author lecorguille
date Fri, 13 Nov 2015 08:51:06 -0500
parents d1c09fc628e5
children 8c5bb7b86df9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
729991209550 Uploaded
mmonsoor
parents: 0
diff changeset
1 <tool id="abims_CAMERA_annotateDiffreport" name="CAMERA.annotate" version="2.1.0">
0
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
2
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
3 <description>CAMERA annotate function. Returns annotation results (isotope peaks, adducts and fragments) and a diffreport if more than one condition.</description>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
4
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
5 <requirements>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
6 <requirement type="package" version="3.1.2">R</requirement>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
7 <requirement type="binary">Rscript</requirement>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
8 <requirement type="package" version="1.44.0">xcms</requirement>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
9 <requirement type="package" version="1.22.0">camera</requirement>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
10 <requirement type="package" version="2.1">camera_w4m_script</requirement>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
11 </requirements>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
12
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
13 <stdio>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
14 <exit_code range="1:" level="fatal" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
15 </stdio>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
16
3
729991209550 Uploaded
mmonsoor
parents: 0
diff changeset
17 <command interpreter="Rscript">
0
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
18 CAMERA.r
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
19 xfunction annotatediff image $image
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
20 convert_param $convert_param num_digits $num_digits nSlaves \${GALAXY_SLOTS:-1}
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
21 sigma $sigma perfwhm $perfwhm
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
22 maxcharge $maxcharge maxiso $maxiso minfrac $minfrac
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
23 ppm $ppm mzabs $mzabs intval $intval
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
24 max_peaks $max_peaks
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
25 quick $quick_block.quick
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
26 #if $quick_block.quick == "FALSE"
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
27 polarity $quick_block.polarity
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
28 cor_eic_th $quick_block.cor_eic_th
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
29 graphMethod $quick_block.graphMethod
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
30 pval $quick_block.pval
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
31 calcCiS $quick_block.calcCiS
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
32 calcIso $quick_block.calcIso
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
33 calcCaS $quick_block.calcCaS
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
34 multiplier $quick_block.multiplier
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
35 #end if
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
36
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
37 #if $options.option == "show":
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
38 eicmax $options.eicmax
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
39 eicwidth $options.eicwidth
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
40 value $options.value
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
41 sortpval $options.sortpval
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
42 h $options.h
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
43 w $options.w
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
44 mzdec $options.mzdec
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
45 #else
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
46 eicmax 0
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
47 eicwidth 200
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
48 value "into"
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
49 sortpval TRUE
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
50 h 480
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
51 w 640
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
52 mzdec 2
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
53 #end if
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
54 &amp;&amp; (
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
55 mv variableMetadata.tsv $variableMetadata;
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
56 mv dataMatrix.tsv $datamatrix;
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
57 mv annotatediff.RData $rdata
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
58 );
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
59 cat xset.log
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
60
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
61
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
62 </command>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
63
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
64 <inputs>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
65
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
66
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
67 <param name="image" type="data" label="RData file" format="rdata.xcms.fillpeaks,rdata" help="output file from another function xcms (fillPeaks)" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
68
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
69 <param name="convert_param" type="boolean" checked="false" truevalue="TRUE" falsevalue="FALSE" label="Convert retention time (seconds) into minutes" help="Convert the columns rtmed, rtmin and rtmax into minutes"/>
5
d1c09fc628e5 Uploaded
mmonsoor
parents: 3
diff changeset
70 <param name="num_digits" type="integer" value="4" label="" help="Number of decimal places for mass values reported in ions identifiers. A minimum of 4 decimal places should be set" />
0
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
71
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
72 <param name="sigma" type="integer" value="6" label="groupFWHM: multiplier of the standard deviation" help="[sigma]" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
73 <param name="perfwhm" type="float" value="0.6" max="1" min="0" label="groupFWHM: percentage of FWHM width" help="[perfwhm]" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
74 <param name="maxcharge" type="integer" value="3" label="findIsotopes: max. ion charge" help="[maxcharge]" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
75 <param name="maxiso" type="integer" value="4" label="findIsotopes: max. number of expected isotopes" help="[maxiso]" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
76 <param name="minfrac" type="float" value="0.5" max="1" min="0" label="findIsotopes: The percentage number of samples, which must satisfy the C12/C13 rule for isotope annotation" help="[minfrac]" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
77 <param name="ppm" type="integer" value="5" label="General ppm error" help="[ppm]" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
78 <param name="mzabs" type="float" value="0.015" label="mzabs" help="General absolut error in m/z" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
79 <param name="intval" type="select" label="General used intensity value" help="[intval] See the help section below">
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
80 <option value="into" selected="true">into</option>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
81 <option value="maxo" >maxo</option>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
82 <option value="intb">intb</option>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
83 </param>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
84
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
85
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
86 <param name="max_peaks" type="integer" value="100" label="How much peaks will be calculated in every thread using the parallel mode" help="[max_peaks]" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
87 <conditional name="quick_block">
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
88 <param name="quick" type="select" label="Quick mode" help="[quick] If TRUE, use only groupFWHM and findIsotopes functions. Else if FALSE, use also groupCorr and findAdducts">
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
89 <option value="TRUE">TRUE</option>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
90 <option value="FALSE" selected="true">FALSE</option>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
91 </param>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
92 <when value="FALSE">
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
93 <param name="polarity" type="select" label="findAdducts: Which polarity mode was used for measuring of the ms sample" help="polarity">
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
94 <option value="positive" >positive</option>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
95 <option value="negative" selected="true">negative</option>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
96 </param>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
97 <param name="cor_eic_th" type="float" value="0.75" max="1" min="0" label="groupCorr: correlation threshold (0..1)" help="[cor_eic_th]" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
98 <param name="graphMethod" type="select" label="groupCorr: Method selection for grouping peaks after correlation analysis into pseudospectra" help="[graphMethod]">
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
99 <option value="hcs" selected="true">hcs</option>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
100 <option value="lpc">lpc</option>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
101 </param>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
102 <param name="pval" type="float" value="0.05" max="1" min="0" label="groupCorr: significant correlation threshold" help="[pval]" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
103 <param name="calcCiS" type="boolean" checked="true" truevalue="TRUE" falsevalue="FALSE" label="groupCorr: Use correlation inside samples for peak grouping" help="[calcCiS]"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
104 <param name="calcIso" type="boolean" checked="false" truevalue="TRUE" falsevalue="FALSE" label="groupCorr: Use isotopic relationship for peak grouping" help="[calcIso]"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
105 <param name="calcCaS" type="boolean" checked="false" truevalue="TRUE" falsevalue="FALSE" label="groupCorr: Use correlation across samples for peak grouping" help="[calcCaS]"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
106 <param name="multiplier" type="integer" value="3" label="findAdducts: If no ruleset is provided, calculate ruleset with max. number n of [nM+x] clusterions" help="[multiplier]" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
107 </when>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
108 <when value="TRUE">
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
109 <param name="polarity" type="hidden" value="quick" label="for the output label" help="for the output label" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
110 </when>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
111 </conditional>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
112
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
113
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
114 <!-- Annotatediffreport specific parameters -->
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
115 <conditional name="options">
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
116 <param name="option" type="select" label="Number of condition">
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
117 <option value="hide" selected="true">One condition</option>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
118 <option value="show">Two or more conditions</option>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
119 </param>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
120 <when value="show">
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
121 <param name="eicmax" type="integer" value="0" label="diffreport: number of the most significantly different analytes to create EICs for" help="[eicmax]" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
122 <param name="eicwidth" type="integer" value="200" label="diffreport: width (in seconds) of EICs produced" help="[eicwidth]" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
123 <param name="value" type="select" label="diffreport: Intensity values to be used for the diffreport" help="[value]">
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
124 <option value="into" selected="true">into</option>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
125 <option value="maxo" >maxo</option>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
126 <option value="intb">intb</option>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
127 </param>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
128 <param name="h" type="integer" value="480" label="diffreport: Numeric variable for the height of the eic and boxplots that are printed out" help="[height]" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
129 <param name="w" type="integer" value="640" label="diffreport: Numeric variable for the width of the eic and boxplots print out made" help="[width]" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
130 <param name="mzdec" type="integer" value="2" label="diffreport: Number of decimal places of title m/z values in the eic plot" help="[mzdec]" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
131 <param name="sortpval" type="boolean" checked="false" truevalue="TRUE" falsevalue="FALSE" label="diffreport: logical indicating whether the reports should be sorted by p-value" help="[sortpval]"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
132 </when>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
133 <when value="hide">
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
134 </when>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
135 </conditional>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
136
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
137 </inputs>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
138
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
139 <outputs>
3
729991209550 Uploaded
mmonsoor
parents: 0
diff changeset
140 <data name="variableMetadata" format="tabular" label="${image.name[:-6]}.annotate.variableMetadata.tsv" />
0
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
141 <data name="datamatrix" format="tabular" label="${image.name[:-6]}.annotate.dataMatrix.tsv" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
142 <data name="rdata" format="rdata.camera.quick" label="${image.name[:-6]}.annotate.${$quick_block.polarity}.Rdata" >
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
143 <change_format>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
144 <when input="quick_block.polarity" value="positive" format="rdata.camera.positive" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
145 <when input="quick_block.polarity" value="negative" format="rdata.camera.negative" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
146 </change_format>
3
729991209550 Uploaded
mmonsoor
parents: 0
diff changeset
147 </data>
729991209550 Uploaded
mmonsoor
parents: 0
diff changeset
148 <data name="output_zip" format="zip" from_work_dir="Xdiffreport.zip" label="${image.name[:-6]}.annotateDiffreport.zip" >
729991209550 Uploaded
mmonsoor
parents: 0
diff changeset
149 <filter>(options['option'] == 'show')</filter>
729991209550 Uploaded
mmonsoor
parents: 0
diff changeset
150 </data>
0
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
151 </outputs>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
152
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
153 <tests>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
154 <test>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
155 <param name="image" value="xset.group.retcor.group.fillPeaks.RData"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
156 <param name="convert_param" value="False"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
157 <param name="num_digits" value="0"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
158 <param name="sigma" value="6"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
159 <param name="perfwhm" value="0.6"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
160 <param name="maxcharge" value="3"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
161 <param name="maxiso" value="4"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
162 <param name="minfrac" value="0.5"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
163 <param name="ppm" value="5"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
164 <param name="mzabs" value="0.015"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
165 <param name="intval" value="into"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
166 <param name="max_peaks" value="100"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
167 <param name="quick_block.quick" value="FALSE"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
168 <param name="quick_block.polarity" value="negative"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
169 <param name="quick_block.cor_eic_th" value="0.75"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
170 <param name="quick_block.graphMethod" value="hcs"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
171 <param name="quick_block.pval" value="0.05"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
172 <param name="quick_block.calcCiS" value="True"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
173 <param name="quick_block.calcIso" value="False"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
174 <param name="quick_block.calcCaS" value="False"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
175 <param name="quick_block.multiplier" value="3"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
176 <param name="options.option" value="show"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
177 <param name="options.eicmax" value="200"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
178 <param name="options.eicwidth" value="200"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
179 <param name="options.value" value="into"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
180 <param name="options.h" value="480"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
181 <param name="options.w" value="640"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
182 <param name="options.mzdec" value="2"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
183 <param name="options.sortpval" value="False"/>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
184 <output name="variableMetadata" file="xset.group.retcor.group.fillPeaks.annotate.variableMetadata.tsv" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
185 <output name="datamatrix" file="xset.group.retcor.group.fillPeaks.annotate.dataMatrix.tsv" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
186 <output name="rdata" file="xset.group.retcor.group.fillPeaks.annotate.negative.Rdata" />
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
187 </test>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
188 </tests>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
189
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
190
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
191
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
192 <help>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
193
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
194 .. class:: infomark
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
195
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
196 **Authors** Carsten Kuhl ckuhl@ipb-halle.de, Ralf Tautenhahn rtautenh@scripps.edu, Steffen Neumann sneumann@@ipb-halle.de
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
197
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
198 .. class:: infomark
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
199
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
200 **Galaxy integration** ABiMS TEAM - UPMC/CNRS - Station biologique de Roscoff and Yann Guitton yann.guitton@univ-nantes.fr - part of Workflow4Metabolomics.org [W4M]
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
201
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
202 | Contact support@workflow4metabolomics.org for any questions or concerns about the Galaxy implementation of this tool.
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
203
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
204 ---------------------------------------------------
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
205
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
206
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
207 ================
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
208 CAMERA.annotate
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
209 ================
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
210
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
211 -----------
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
212 Description
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
213 -----------
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
214
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
215 The R-package CAMERA is a Collection of Algorithms for MEtabolite
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
216 pRofile Annotation. Its primary purpose is the annotation and evaluation of
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
217 LC-MS data. It includes algorithms for annotation of isotope peaks, adducts
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
218 and fragments in peak lists. Additional methods cluster mass signals that
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
219 originate from a single metabolite, based on rules for mass differences and
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
220 peak shape comparison. To use the strength of already existing programs,
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
221 CAMERA is designed to interact directly with processed peak data from the
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
222 R-package **xcms**.
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
223
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
224 **What it does?**
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
225
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
226 The CAMERA annotation procedure can be split into two parts: We want to answer the questions which peaks occur from the same molecule and secondly compute its exact mass and annotate the ion species. Therefore CAMERA annotation workflow contains following primary functions: 1. peak grouping after retention time (**groupFWHM**) 2. peak group verification with peakshape correlation (**groupCorr**) Both methods separate peaks into different groups, which we define as ”pseu- dospectra”. Those pseudospectra can consists from one up to 100 ions, de- pending on the molecules amount and ionizability. Afterwards the exposure of the ion species can be performed with: 2 1. annotation of possible isotopes (**findIsotopes**) 2. annotation of adducts and calculating hypothetical masses for the group (**findAdducts**) This workflow results in a data-frame similar to a xcms peak table, that can be easily stored in a comma separated table .csv (Excel-readable).
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
227
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
228 If you have two or more conditions, it will return a diffreport result within the annotation results.
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
229 The diffreport result shows the most significant differences between two sets of samples. Optionally
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
230 create extracted ion chromatograms for the most significant differences.
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
231
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
232
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
233 -----------------
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
234 Workflow position
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
235 -----------------
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
236
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
237
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
238 **Upstream tools**
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
239
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
240 ========================= ==================== ====================== ==========
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
241 Name output file format parameter
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
242 ========================= ==================== ====================== ==========
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
243 xcms.fillPeaks xset.fillPeaks.RData rdata.xcms.fillpeaks RData file
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
244 ========================= ==================== ====================== ==========
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
245
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
246
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
247 **Downstream tools**
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
248
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
249 +---------------------------+---------------------------------------+------------------------------------------------+
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
250 | Name | Output file | Format |
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
251 +===========================+=======================================+================================================+
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
252 |CAMERA_combinexsAnnot |xset.annotate.dataMatrix.tsv | rdata.camera.positive or rdata.camera.negative |
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
253 +---------------------------+---------------------------------------+------------------------------------------------+
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
254 |Determine Vdk or Lowess |xset.annotate.dataMatrix.tsv | Tabular |
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
255 +---------------------------+---------------------------------------+------------------------------------------------+
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
256 |Normalization Vdk/Lowess |xset.annotate.dataMatrix.tsv | Tabular |
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
257 +---------------------------+---------------------------------------+------------------------------------------------+
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
258 |Anova |xset.annotate.dataMatrix.tsv | Tabular |
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
259 +---------------------------+---------------------------------------+------------------------------------------------+
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
260 |PCA |xset.annotate.dataMatrix.tsv | Tabular |
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
261 +---------------------------+---------------------------------------+------------------------------------------------+
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
262 |Hierarchical Clustering |xset.annotate.dataMatrix.tsv | Tabular |
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
263 +---------------------------+---------------------------------------+------------------------------------------------+
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
264
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
265
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
266 The output file **xset.annotate.dataMatrix.tsv** is an tabular file. You can continue your analysis using it in the following tools:
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
267
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
268 | Determine Vdk or Lowess
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
269 | Normalization Vdk/Lowess
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
270 | Anova
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
271 | PCA
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
272 | Hierarchical Clustering
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
273
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
274
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
275 **General schema of the metabolomic workflow**
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
276
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
277 .. image:: annotate_workflow.png
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
278
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
279 -----------
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
280 Input files
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
281 -----------
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
282
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
283 +---------------------------+---------------------------+
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
284 | Parameter : num + label | Format |
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
285 +===========================+===========================+
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
286 | 1 : RData file | rdata.xcms.fillpeaks |
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
287 +---------------------------+---------------------------+
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
288
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
289
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
290 ----------
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
291 Parameters
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
292 ----------
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
293
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
294 diffreport: Intensity values to be used for the diffreport
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
295 ----------------------------------------------------------
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
296
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
297 | If **value="into"**, integrated peak intensities are used.
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
298 | If **value="maxo"**, maximum peak intensities are used.
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
299 | If **value="intb"**, baseline corrected integrated peak intensities are used (only available if peak detection was done by ‘findPeaks.centWave’).
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
300
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
301
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
302
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
303 ------------
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
304 Output files
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
305 ------------
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
306
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
307 xset.annotate.variableMetadata.tsv
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
308
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
309 | For each metabolite (row) :
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
310 | the value of the intensity in each sample, fold, anova, mzmed, mzmin, mzmax, rtmed, rtmin, rtmax, npeaks, isotopes, adduct and pcgroup
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
311
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
312 xset.annotate.dataMatrix.tsv
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
313
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
314 | A tabular file which represents for each metabolite (row), the value of the intensity in each sample (column).
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
315
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
316 xset.annotate.zip
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
317
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
318 | It contains filebase_eic, filebase_box and filebase.tsv for one conditon vs another (Anova analysis).
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
319
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
320 xset.annotate.Rdata rdata.camera.quick or rdata.camera.positive or rdata.camera.negative
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
321
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
322 | Rdata file, that be used outside Galaxy in R.
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
323
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
324 ------
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
325
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
326 .. class:: infomark
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
327
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
328 The output **"xset.annotate.dataMatrix.tsv"** is a tabular file. You can continue your analysis using it in the following tools of the workflow:
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
329
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
330 | Determine Vdk or Lowess (Data correction)
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
331 | Normalization Vdk/Lowess (Data correction)
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
332 | Anova (Statistical analysis)
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
333 | PCA (Statistical analysis)
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
334 | Hierarchical Clustering (Statistical analysis)
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
335
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
336
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
337 ---------------------------------------------------
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
338
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
339 ---------------
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
340 Working example
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
341 ---------------
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
342
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
343 Input files
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
344 -----------
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
345
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
346 | RData file -> **xset.fillPeaks.RData**
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
347
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
348 Parameters
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
349 ----------
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
350
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
351 | sortpval -> **false**
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
352 | sigma -> **6 (default)**
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
353 | perfwhm -> **0.6 (default)**
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
354 | maxcharge -> **3 (default)**
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
355 | maxiso -> **4 (default)**
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
356 | minfrac -> **0.5 (default)**
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
357 | ppm -> **500**
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
358 | mzabs -> **0.015(default)**
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
359 | Advanced options -> **hide**
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
360 | Numver of condition -> Two or more conditioons
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
361 | eicmax -> **200**
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
362 | eicwidth -> **200 (default)**
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
363
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
364
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
365
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
366 Output files
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
367 ------------
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
368
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
369 **Example of an xset.annotate.dataMatrix.tsv output**
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
370
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
371 .. image:: annotatediffreport_dataMatrix.png
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
372
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
373 **Example of a part of xset.annotate.variableMetadata.tsv output**
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
374
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
375 .. image:: annotatediffreport_variableMetadata.png
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
376
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
377 </help>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
378
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
379 <citations>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
380 <citation type="doi">10.1021/ac202450g</citation>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
381 <citation type="doi">10.1093/bioinformatics/btu813</citation>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
382 </citations>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
383
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
384
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
385 </tool>
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
386
e0afb8854cc4 planemo upload
lecorguille
parents:
diff changeset
387