annotate abims_CAMERA_annotateDiffreport.xml @ 9:c02d80efba80 draft

planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
author lecorguille
date Sun, 10 Apr 2016 08:14:59 -0400
parents 32b0e4bc881f
children d33e0ed5f32a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
57dce001024c Uploaded
lecorguille
parents: 2
diff changeset
1 <tool id="abims_CAMERA_annotateDiffreport" name="CAMERA.annotate" version="2.1.3">
0
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
2
b495191430d5 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>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
4
9
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
5 <macros>
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
6 <import>macros.xml</import>
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
7 </macros>
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
8
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
9 <expand macro="requirements"/>
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
10 <expand macro="stdio"/>
0
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
11
1
a887bff50e45 Uploaded
lecorguille
parents: 0
diff changeset
12 <command><![CDATA[
9
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
13 @COMMAND_CAMERA_SCRIPT@
1
a887bff50e45 Uploaded
lecorguille
parents: 0
diff changeset
14 xfunction annotatediff
a887bff50e45 Uploaded
lecorguille
parents: 0
diff changeset
15 image $image
a887bff50e45 Uploaded
lecorguille
parents: 0
diff changeset
16
a887bff50e45 Uploaded
lecorguille
parents: 0
diff changeset
17 variableMetadataOutput $variableMetadata
a887bff50e45 Uploaded
lecorguille
parents: 0
diff changeset
18 dataMatrixOutput $datamatrix
a887bff50e45 Uploaded
lecorguille
parents: 0
diff changeset
19 xsetRdataOutput $rdata
a887bff50e45 Uploaded
lecorguille
parents: 0
diff changeset
20
a887bff50e45 Uploaded
lecorguille
parents: 0
diff changeset
21 convert_param $convert_param num_digits $num_digits
a887bff50e45 Uploaded
lecorguille
parents: 0
diff changeset
22 nSlaves \${GALAXY_SLOTS:-1}
0
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
23 sigma $sigma perfwhm $perfwhm
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
24 maxcharge $maxcharge maxiso $maxiso minfrac $minfrac
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
25 ppm $ppm mzabs $mzabs intval $intval
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
26 max_peaks $max_peaks
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
27 quick $quick_block.quick
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
28 #if $quick_block.quick == "FALSE"
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
29 polarity $quick_block.polarity
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
30 cor_eic_th $quick_block.cor_eic_th
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
31 graphMethod $quick_block.graphMethod
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
32 pval $quick_block.pval
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
33 calcCiS $quick_block.calcCiS
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
34 calcIso $quick_block.calcIso
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
35 calcCaS $quick_block.calcCaS
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
36 multiplier $quick_block.multiplier
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
37 #end if
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
38
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
39 #if $options.option == "show":
3
57dce001024c Uploaded
lecorguille
parents: 2
diff changeset
40 runDiffreport TRUE
0
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
41 eicmax $options.eicmax
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
42 eicwidth $options.eicwidth
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
43 value $options.value
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
44 sortpval $options.sortpval
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
45 h $options.h
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
46 w $options.w
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
47 mzdec $options.mzdec
1
a887bff50e45 Uploaded
lecorguille
parents: 0
diff changeset
48 new_file_path ${__new_file_path__}/primary_${output_diffreport.id}_
0
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
49 #end if
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
50
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
51
1
a887bff50e45 Uploaded
lecorguille
parents: 0
diff changeset
52 ]]></command>
0
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
53
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
54 <inputs>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
55
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
56
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
57 <param name="image" type="data" label="RData file" format="rdata.xcms.fillpeaks,rdata" help="output file from another function xcms (fillPeaks)" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
58
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
59 <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"/>
1
a887bff50e45 Uploaded
lecorguille
parents: 0
diff changeset
60 <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
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
61
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
62 <param name="sigma" type="integer" value="6" label="groupFWHM: multiplier of the standard deviation" help="[sigma]" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
63 <param name="perfwhm" type="float" value="0.6" max="1" min="0" label="groupFWHM: percentage of FWHM width" help="[perfwhm]" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
64 <param name="maxcharge" type="integer" value="3" label="findIsotopes: max. ion charge" help="[maxcharge]" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
65 <param name="maxiso" type="integer" value="4" label="findIsotopes: max. number of expected isotopes" help="[maxiso]" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
66 <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]" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
67 <param name="ppm" type="integer" value="5" label="General ppm error" help="[ppm]" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
68 <param name="mzabs" type="float" value="0.015" label="mzabs" help="General absolut error in m/z" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
69 <param name="intval" type="select" label="General used intensity value" help="[intval] See the help section below">
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
70 <option value="into" selected="true">into</option>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
71 <option value="maxo" >maxo</option>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
72 <option value="intb">intb</option>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
73 </param>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
74
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
75
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
76 <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]" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
77 <conditional name="quick_block">
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
78 <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">
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
79 <option value="TRUE">TRUE</option>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
80 <option value="FALSE" selected="true">FALSE</option>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
81 </param>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
82 <when value="FALSE">
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
83 <param name="polarity" type="select" label="findAdducts: Which polarity mode was used for measuring of the ms sample" help="polarity">
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
84 <option value="positive" >positive</option>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
85 <option value="negative" selected="true">negative</option>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
86 </param>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
87 <param name="cor_eic_th" type="float" value="0.75" max="1" min="0" label="groupCorr: correlation threshold (0..1)" help="[cor_eic_th]" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
88 <param name="graphMethod" type="select" label="groupCorr: Method selection for grouping peaks after correlation analysis into pseudospectra" help="[graphMethod]">
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
89 <option value="hcs" selected="true">hcs</option>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
90 <option value="lpc">lpc</option>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
91 </param>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
92 <param name="pval" type="float" value="0.05" max="1" min="0" label="groupCorr: significant correlation threshold" help="[pval]" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
93 <param name="calcCiS" type="boolean" checked="true" truevalue="TRUE" falsevalue="FALSE" label="groupCorr: Use correlation inside samples for peak grouping" help="[calcCiS]"/>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
94 <param name="calcIso" type="boolean" checked="false" truevalue="TRUE" falsevalue="FALSE" label="groupCorr: Use isotopic relationship for peak grouping" help="[calcIso]"/>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
95 <param name="calcCaS" type="boolean" checked="false" truevalue="TRUE" falsevalue="FALSE" label="groupCorr: Use correlation across samples for peak grouping" help="[calcCaS]"/>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
96 <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]" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
97 </when>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
98 <when value="TRUE">
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
99 <param name="polarity" type="hidden" value="quick" label="for the output label" help="for the output label" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
100 </when>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
101 </conditional>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
102
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
103
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
104 <!-- Annotatediffreport specific parameters -->
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
105 <conditional name="options">
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
106 <param name="option" type="select" label="Number of condition">
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
107 <option value="hide" selected="true">One condition</option>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
108 <option value="show">Two or more conditions</option>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
109 </param>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
110 <when value="show">
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
111 <param name="eicmax" type="integer" value="0" label="diffreport: number of the most significantly different analytes to create EICs for" help="[eicmax]" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
112 <param name="eicwidth" type="integer" value="200" label="diffreport: width (in seconds) of EICs produced" help="[eicwidth]" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
113 <param name="value" type="select" label="diffreport: Intensity values to be used for the diffreport" help="[value]">
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
114 <option value="into" selected="true">into</option>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
115 <option value="maxo" >maxo</option>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
116 <option value="intb">intb</option>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
117 </param>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
118 <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]" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
119 <param name="w" type="integer" value="640" label="diffreport: Numeric variable for the width of the eic and boxplots print out made" help="[width]" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
120 <param name="mzdec" type="integer" value="2" label="diffreport: Number of decimal places of title m/z values in the eic plot" help="[mzdec]" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
121 <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]"/>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
122 </when>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
123 <when value="hide">
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
124 </when>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
125 </conditional>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
126
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
127 </inputs>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
128
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
129 <outputs>
1
a887bff50e45 Uploaded
lecorguille
parents: 0
diff changeset
130 <data name="variableMetadata" format="tabular" label="${image.name[:-6]}.annotate.variableMetadata.tsv" />
0
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
131 <data name="datamatrix" format="tabular" label="${image.name[:-6]}.annotate.dataMatrix.tsv" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
132 <data name="rdata" format="rdata.camera.quick" label="${image.name[:-6]}.annotate.${$quick_block.polarity}.Rdata" >
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
133 <change_format>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
134 <when input="quick_block.polarity" value="positive" format="rdata.camera.positive" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
135 <when input="quick_block.polarity" value="negative" format="rdata.camera.negative" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
136 </change_format>
1
a887bff50e45 Uploaded
lecorguille
parents: 0
diff changeset
137 </data>
a887bff50e45 Uploaded
lecorguille
parents: 0
diff changeset
138 <data name="output_diffreport" format="text" label="${image.name[:-6]}.annotateDiffreport" hidden="True">
a887bff50e45 Uploaded
lecorguille
parents: 0
diff changeset
139 <filter>(options['option'] == 'show')</filter>
a887bff50e45 Uploaded
lecorguille
parents: 0
diff changeset
140 </data>
0
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
141 </outputs>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
142
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
143 <tests>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
144 <test>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
145 <param name="image" value="xset.group.retcor.group.fillPeaks.RData"/>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
146 <param name="convert_param" value="False"/>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
147 <param name="num_digits" value="0"/>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
148 <param name="sigma" value="6"/>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
149 <param name="perfwhm" value="0.6"/>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
150 <param name="maxcharge" value="3"/>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
151 <param name="maxiso" value="4"/>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
152 <param name="minfrac" value="0.5"/>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
153 <param name="ppm" value="5"/>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
154 <param name="mzabs" value="0.015"/>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
155 <param name="intval" value="into"/>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
156 <param name="max_peaks" value="100"/>
9
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
157 <param name="quick_block|quick" value="FALSE"/>
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
158 <param name="quick_block|polarity" value="negative"/>
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
159 <param name="quick_block|cor_eic_th" value="0.75"/>
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
160 <param name="quick_block|graphMethod" value="hcs"/>
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
161 <param name="quick_block|pval" value="0.05"/>
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
162 <param name="quick_block|calcCiS" value="True"/>
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
163 <param name="quick_block|calcIso" value="False"/>
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
164 <param name="quick_block|calcCaS" value="False"/>
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
165 <param name="quick_block|multiplier" value="3"/>
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
166 <param name="options|option" value="show"/>
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
167 <param name="options|eicmax" value="200"/>
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
168 <param name="options|eicwidth" value="200"/>
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
169 <param name="options|value" value="into"/>
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
170 <param name="options|h" value="480"/>
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
171 <param name="options|w" value="640"/>
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
172 <param name="options|mzdec" value="2"/>
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
173 <param name="options|sortpval" value="False"/>
0
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
174 <output name="variableMetadata" file="xset.group.retcor.group.fillPeaks.annotate.variableMetadata.tsv" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
175 <output name="datamatrix" file="xset.group.retcor.group.fillPeaks.annotate.dataMatrix.tsv" />
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
176 </test>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
177 </tests>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
178
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
179
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
180
1
a887bff50e45 Uploaded
lecorguille
parents: 0
diff changeset
181 <help><![CDATA[
0
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
182
9
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
183 @HELP_AUTHORS@
0
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
184
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
185 ================
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
186 CAMERA.annotate
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
187 ================
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
188
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
189 -----------
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
190 Description
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
191 -----------
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
192
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
193 The R-package CAMERA is a Collection of Algorithms for MEtabolite
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
194 pRofile Annotation. Its primary purpose is the annotation and evaluation of
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
195 LC-MS data. It includes algorithms for annotation of isotope peaks, adducts
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
196 and fragments in peak lists. Additional methods cluster mass signals that
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
197 originate from a single metabolite, based on rules for mass differences and
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
198 peak shape comparison. To use the strength of already existing programs,
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
199 CAMERA is designed to interact directly with processed peak data from the
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
200 R-package **xcms**.
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
201
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
202 **What it does?**
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
203
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
204 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).
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
205
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
206 If you have two or more conditions, it will return a diffreport result within the annotation results.
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
207 The diffreport result shows the most significant differences between two sets of samples. Optionally
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
208 create extracted ion chromatograms for the most significant differences.
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
209
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
210
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
211 -----------------
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
212 Workflow position
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
213 -----------------
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
214
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
215
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
216 **Upstream tools**
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
217
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
218 ========================= ==================== ====================== ==========
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
219 Name output file format parameter
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
220 ========================= ==================== ====================== ==========
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
221 xcms.fillPeaks xset.fillPeaks.RData rdata.xcms.fillpeaks RData file
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
222 ========================= ==================== ====================== ==========
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
223
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
224
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
225 **Downstream tools**
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
226
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
227 +---------------------------+---------------------------------------+------------------------------------------------+
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
228 | Name | Output file | Format |
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
229 +===========================+=======================================+================================================+
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
230 |CAMERA_combinexsAnnot |xset.annotate.dataMatrix.tsv | rdata.camera.positive or rdata.camera.negative |
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
231 +---------------------------+---------------------------------------+------------------------------------------------+
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
232 |Determine Vdk or Lowess |xset.annotate.dataMatrix.tsv | Tabular |
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
233 +---------------------------+---------------------------------------+------------------------------------------------+
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
234 |Normalization Vdk/Lowess |xset.annotate.dataMatrix.tsv | Tabular |
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
235 +---------------------------+---------------------------------------+------------------------------------------------+
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
236 |Anova |xset.annotate.dataMatrix.tsv | Tabular |
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
237 +---------------------------+---------------------------------------+------------------------------------------------+
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
238 |PCA |xset.annotate.dataMatrix.tsv | Tabular |
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
239 +---------------------------+---------------------------------------+------------------------------------------------+
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
240 |Hierarchical Clustering |xset.annotate.dataMatrix.tsv | Tabular |
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
241 +---------------------------+---------------------------------------+------------------------------------------------+
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
242
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
243
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
244 The output file **xset.annotate.dataMatrix.tsv** is an tabular file. You can continue your analysis using it in the following tools:
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
245
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
246 | Determine Vdk or Lowess
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
247 | Normalization Vdk/Lowess
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
248 | Anova
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
249 | PCA
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
250 | Hierarchical Clustering
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
251
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
252
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
253 **General schema of the metabolomic workflow**
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
254
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
255 .. image:: annotate_workflow.png
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
256
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
257 -----------
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
258 Input files
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
259 -----------
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
260
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
261 +---------------------------+---------------------------+
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
262 | Parameter : num + label | Format |
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
263 +===========================+===========================+
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
264 | 1 : RData file | rdata.xcms.fillpeaks |
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
265 +---------------------------+---------------------------+
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
266
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
267
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
268 ----------
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
269 Parameters
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
270 ----------
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
271
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
272 diffreport: Intensity values to be used for the diffreport
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
273 ----------------------------------------------------------
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
274
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
275 | If **value="into"**, integrated peak intensities are used.
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
276 | If **value="maxo"**, maximum peak intensities are used.
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
277 | If **value="intb"**, baseline corrected integrated peak intensities are used (only available if peak detection was done by ‘findPeaks.centWave’).
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
278
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
279
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
280
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
281 ------------
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
282 Output files
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
283 ------------
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
284
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
285 xset.annotate.variableMetadata.tsv
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
286
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
287 | For each metabolite (row) :
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
288 | the value of the intensity in each sample, fold, anova, mzmed, mzmin, mzmax, rtmed, rtmin, rtmax, npeaks, isotopes, adduct and pcgroup
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
289
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
290 xset.annotate.dataMatrix.tsv
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
291
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
292 | A tabular file which represents for each metabolite (row), the value of the intensity in each sample (column).
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
293
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
294 xset.annotate.zip
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
295
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
296 | It contains filebase_eic, filebase_box and filebase.tsv for one conditon vs another (Anova analysis).
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
297
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
298 xset.annotate.Rdata rdata.camera.quick or rdata.camera.positive or rdata.camera.negative
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
299
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
300 | Rdata file, that be used outside Galaxy in R.
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
301
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
302 ------
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
303
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
304 .. class:: infomark
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
305
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
306 The output **"xset.annotate.dataMatrix.tsv"** is a tabular file. You can continue your analysis using it in the following tools of the workflow:
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
307
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
308 | Determine Vdk or Lowess (Data correction)
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
309 | Normalization Vdk/Lowess (Data correction)
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
310 | Anova (Statistical analysis)
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
311 | PCA (Statistical analysis)
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
312 | Hierarchical Clustering (Statistical analysis)
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
313
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
314
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
315 ---------------------------------------------------
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
316
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
317 ---------------
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
318 Working example
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
319 ---------------
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
320
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
321 Input files
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
322 -----------
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
323
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
324 | RData file -> **xset.fillPeaks.RData**
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
325
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
326 Parameters
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
327 ----------
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
328
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
329 | sortpval -> **false**
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
330 | sigma -> **6 (default)**
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
331 | perfwhm -> **0.6 (default)**
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
332 | maxcharge -> **3 (default)**
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
333 | maxiso -> **4 (default)**
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
334 | minfrac -> **0.5 (default)**
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
335 | ppm -> **500**
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
336 | mzabs -> **0.015(default)**
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
337 | Advanced options -> **hide**
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
338 | Numver of condition -> Two or more conditioons
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
339 | eicmax -> **200**
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
340 | eicwidth -> **200 (default)**
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
341
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
342
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
343
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
344 Output files
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
345 ------------
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
346
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
347 **Example of an xset.annotate.dataMatrix.tsv output**
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
348
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
349 .. image:: annotatediffreport_dataMatrix.png
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
350
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
351 **Example of a part of xset.annotate.variableMetadata.tsv output**
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
352
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
353 .. image:: annotatediffreport_variableMetadata.png
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
354
6
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
355
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
356 ---------------------------------------------------
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
357
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
358 Changelog/News
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
359 --------------
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
360
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
361 **Version 2.1.3 - 10/02/2016**
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
362
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
363 - BUGFIX: better management of errors. Datasets remained green although the process failed
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
364
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
365 - BUGFIX: the conversion into minutes of the retention time was applied to the diffreport outputs (several conditions)
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
366
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
367 - IMPROVEMENT: when there are several conditions, the tool will generate individual datasets (tsv, pdf) instead of a zip file. The usual png (eic, boxplot) will from now be integrated in two pdf.
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
368
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
369 - UPDATE: refactoring of internal management of inputs/outputs
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
370
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
371
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
372 VERSION 2.1.0 - 09/10/2015**
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
373
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
374 - BUGFIX: There was a bug with the CAMERA.annotate (generating a bad dataMatrix (intensities which don't match with the metabolites))
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
375
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
376
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
377 VERSION 2.1.0 - 07/06/2015**
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
378
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
379 - IMPROVEMENT: new datatype/dataset formats (rdata.camera.positive, rdata.camera.negative, rdata.camera.quick ...) will facilitate the sequence of tools and so avoid incompatibility errors.
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
380
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
381 - IMPROVEMENT: parameter labels have changed to facilitate their reading.
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
382
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
383 - UPDATE: merged with annotateDiffreport. Some parameters are dedicated to experiences with several conditions
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
384
32b0e4bc881f Uploaded
lecorguille
parents: 5
diff changeset
385
1
a887bff50e45 Uploaded
lecorguille
parents: 0
diff changeset
386 ]]></help>
0
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
387
9
c02d80efba80 planemo upload commit d8cc436fd91f5748dc396d0527a0a303d3221835
lecorguille
parents: 6
diff changeset
388 <expand macro="citation" />
0
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
389
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
390
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
391 </tool>
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
392
b495191430d5 planemo upload
lecorguille
parents:
diff changeset
393