annotate abims_xcms_xcmsSet.xml @ 4:c5fa73f1703f draft

Uploaded
author mmonsoor
date Tue, 24 Nov 2015 06:06:30 -0500
parents 054e4681667c
children 588b0a7ae4b0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
054e4681667c planemo upload
lecorguille
parents:
diff changeset
1 <tool id="abims_xcms_xcmsSet" name="xcms.xcmsSet" version="2.0.2">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
2
054e4681667c planemo upload
lecorguille
parents:
diff changeset
3 <description>Filtration and Peak Identification using xcmsSet function from xcms R package to preprocess LC/MS data for relative quantification and statistical analysis </description>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
4
054e4681667c planemo upload
lecorguille
parents:
diff changeset
5 <requirements>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
6 <requirement type="package" version="3.1.2">R</requirement>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
7 <requirement type="binary">Rscript</requirement>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
8 <requirement type="package" version="1.44.0">xcms</requirement>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
9 <requirement type="package" version="2.1">xcms_w4m_script</requirement>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
10 </requirements>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
11
054e4681667c planemo upload
lecorguille
parents:
diff changeset
12 <stdio>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
13 <exit_code range="1:" level="fatal" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
14 </stdio>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
15
054e4681667c planemo upload
lecorguille
parents:
diff changeset
16 <command>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
17 xcms.r
054e4681667c planemo upload
lecorguille
parents:
diff changeset
18 #if $inputs.input == "lib":
054e4681667c planemo upload
lecorguille
parents:
diff changeset
19 library $__app__.config.user_library_import_dir/$__user_email__/$inputs.library
054e4681667c planemo upload
lecorguille
parents:
diff changeset
20 #elif $inputs.input == "zip_file":
054e4681667c planemo upload
lecorguille
parents:
diff changeset
21 zipfile $inputs.zip_file
054e4681667c planemo upload
lecorguille
parents:
diff changeset
22 #end if
054e4681667c planemo upload
lecorguille
parents:
diff changeset
23
054e4681667c planemo upload
lecorguille
parents:
diff changeset
24 xfunction xcmsSet
054e4681667c planemo upload
lecorguille
parents:
diff changeset
25 ## profmethod $profmethod
054e4681667c planemo upload
lecorguille
parents:
diff changeset
26 nSlaves \${GALAXY_SLOTS:-1} method $methods.method
054e4681667c planemo upload
lecorguille
parents:
diff changeset
27 #if $methods.method == "centWave":
054e4681667c planemo upload
lecorguille
parents:
diff changeset
28 ppm $methods.ppm
054e4681667c planemo upload
lecorguille
parents:
diff changeset
29 peakwidth "c($methods.peakwidth)"
054e4681667c planemo upload
lecorguille
parents:
diff changeset
30 #if $methods.options_scanrange.option == "show":
054e4681667c planemo upload
lecorguille
parents:
diff changeset
31 scanrange "c($methods.options_scanrange.scanrange)"
054e4681667c planemo upload
lecorguille
parents:
diff changeset
32 #end if
054e4681667c planemo upload
lecorguille
parents:
diff changeset
33 #if $methods.options_c.option == "show":
054e4681667c planemo upload
lecorguille
parents:
diff changeset
34 mzdiff $methods.options_c.mzdiff
054e4681667c planemo upload
lecorguille
parents:
diff changeset
35 snthresh $methods.options_c.snthresh
054e4681667c planemo upload
lecorguille
parents:
diff changeset
36 integrate $methods.options_c.integrate
054e4681667c planemo upload
lecorguille
parents:
diff changeset
37 noise $methods.options_c.noise
054e4681667c planemo upload
lecorguille
parents:
diff changeset
38 prefilter "c($methods.options_c.prefilter)"
054e4681667c planemo upload
lecorguille
parents:
diff changeset
39 #end if
054e4681667c planemo upload
lecorguille
parents:
diff changeset
40 #elif $methods.method == "matchedFilter":
054e4681667c planemo upload
lecorguille
parents:
diff changeset
41 step $methods.step
054e4681667c planemo upload
lecorguille
parents:
diff changeset
42 fwhm $methods.fwhm
054e4681667c planemo upload
lecorguille
parents:
diff changeset
43 #if $methods.options_m.option == "show":
054e4681667c planemo upload
lecorguille
parents:
diff changeset
44 ## sigma "$methods.options_m.sigma"
054e4681667c planemo upload
lecorguille
parents:
diff changeset
45 max $methods.options_m.max
054e4681667c planemo upload
lecorguille
parents:
diff changeset
46 snthresh $methods.options_m.snthresh
054e4681667c planemo upload
lecorguille
parents:
diff changeset
47 ## mzdiff $methods.options_m.mzdiff
054e4681667c planemo upload
lecorguille
parents:
diff changeset
48 steps $methods.options_m.steps
054e4681667c planemo upload
lecorguille
parents:
diff changeset
49 ## sleep $methods.options_m.sleep
054e4681667c planemo upload
lecorguille
parents:
diff changeset
50 #end if
054e4681667c planemo upload
lecorguille
parents:
diff changeset
51 #elif $methods.method == "MSW":
054e4681667c planemo upload
lecorguille
parents:
diff changeset
52 snthr $methods.snthr
054e4681667c planemo upload
lecorguille
parents:
diff changeset
53 nearbyPeak $methods.nearbyPeak
054e4681667c planemo upload
lecorguille
parents:
diff changeset
54 winSize.noise $methods.winSize_noise
054e4681667c planemo upload
lecorguille
parents:
diff changeset
55 amp.Th $methods.amp_Th
054e4681667c planemo upload
lecorguille
parents:
diff changeset
56 scales "c($methods.scales)"
054e4681667c planemo upload
lecorguille
parents:
diff changeset
57 SNR.method "$methods.SNR_method"
054e4681667c planemo upload
lecorguille
parents:
diff changeset
58 #end if
054e4681667c planemo upload
lecorguille
parents:
diff changeset
59 &amp;&amp; (mv xcmsSet.RData $xsetRData;
054e4681667c planemo upload
lecorguille
parents:
diff changeset
60 mv sampleMetadata.tsv $sampleMetadata;
054e4681667c planemo upload
lecorguille
parents:
diff changeset
61 mv TICs_raw.pdf $ticsRawPdf;
054e4681667c planemo upload
lecorguille
parents:
diff changeset
62 mv BPCs_raw.pdf $bpcsRawPdf;
054e4681667c planemo upload
lecorguille
parents:
diff changeset
63 mv xset.log $log);
054e4681667c planemo upload
lecorguille
parents:
diff changeset
64 cat $log
054e4681667c planemo upload
lecorguille
parents:
diff changeset
65 </command>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
66
054e4681667c planemo upload
lecorguille
parents:
diff changeset
67 <inputs>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
68
054e4681667c planemo upload
lecorguille
parents:
diff changeset
69 <conditional name="inputs">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
70 <param name="input" type="select" label="Choose your inputs method" >
054e4681667c planemo upload
lecorguille
parents:
diff changeset
71 <option value="zip_file" selected="true">Zip file from your history containing your chromatograms</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
72 <option value="lib" >Library directory name</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
73 </param>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
74 <when value="zip_file">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
75 <param name="zip_file" type="data" format="no_unzip.zip" label="Zip file" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
76 </when>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
77 <when value="lib">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
78 <param name="library" type="text" size="40" label="Library directory name" help="The name of your directory containing all your data" >
054e4681667c planemo upload
lecorguille
parents:
diff changeset
79 <validator type="empty_field"/>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
80 </param>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
81 </when>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
82
054e4681667c planemo upload
lecorguille
parents:
diff changeset
83 </conditional>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
84
054e4681667c planemo upload
lecorguille
parents:
diff changeset
85
054e4681667c planemo upload
lecorguille
parents:
diff changeset
86 <!--
054e4681667c planemo upload
lecorguille
parents:
diff changeset
87 <param name="profmethod" type="select" label="Method to use for profile generation (profmethod)" >
054e4681667c planemo upload
lecorguille
parents:
diff changeset
88 <option value="bin" selected="true">bin</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
89 <option value="binlin">binlin</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
90 <option value="binlinbase">binlinbase</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
91 <option value="intlin">intlin</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
92 </param>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
93 <param name="nSlaves" type="integer" value="9" label="MPI-slaves CPU" help="number of MPI-slaves to use for parallel peak detection" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
94 -->
054e4681667c planemo upload
lecorguille
parents:
diff changeset
95 <conditional name="methods">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
96 <param name="method" type="select" label="Extraction method for peaks detection" help="[method] See the help section below">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
97 <option value="centWave" >centWave</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
98 <option value="matchedFilter" selected="true">matchedFilter</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
99 <option value="MSW">MSW</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
100 </param>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
101
054e4681667c planemo upload
lecorguille
parents:
diff changeset
102 <!-- centWave Filter options -->
054e4681667c planemo upload
lecorguille
parents:
diff changeset
103 <when value="centWave">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
104 <param name="ppm" type="integer" value="25" label="Max tolerated ppm m/z deviation in consecutive scans in ppm" help="[ppm]" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
105 <param name="peakwidth" type="text" value="20,50" label="Min,Max peak width in seconds" help="[peakwidth]" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
106 <conditional name="options_scanrange">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
107 <param name="option" type="select" label="Scan range option " >
054e4681667c planemo upload
lecorguille
parents:
diff changeset
108 <option value="show">show</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
109 <option value="hide" selected="true">hide</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
110 </param>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
111 <when value="show">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
112 <param name="scanrange" type="text" value="" label="scanrange" help="scan range to process, for example (16,365)" >
054e4681667c planemo upload
lecorguille
parents:
diff changeset
113 <validator type="empty_field"/>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
114 </param>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
115 </when>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
116 </conditional>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
117
054e4681667c planemo upload
lecorguille
parents:
diff changeset
118 <conditional name="options_c">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
119 <param name="option" type="select" label="Advanced options" >
054e4681667c planemo upload
lecorguille
parents:
diff changeset
120 <option value="show">show</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
121 <option value="hide" selected="true">hide</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
122 </param>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
123 <when value="show">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
124 <param name="snthresh" type="integer" value="10" label="Signal/Noise threshold" help="[snthresh] Signal to noise ratio cutoff" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
125 <param name="mzdiff" type="float" value="-0.001" label="Min m/z difference" help="[mzdiff] Min m/z difference for peaks with overlapping RT " />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
126 <param name="integrate" type="select" label="peak limits method" help="[integrate]" >
054e4681667c planemo upload
lecorguille
parents:
diff changeset
127 <option value="1">peak limits based on smoothed 2nd derivative (less precise)</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
128 <option value="2">peak limits based on real data (more sensitive to noise)</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
129 </param>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
130 <param name="prefilter" type="text" value="3,100" label="Prefilter step for the first phase" help="[prefilter] Separate by coma k,I. Mass traces are only retained if they contain at least ‘k’ peaks with intensity >= ‘I’"/>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
131 <param name="noise" type="integer" value="0" label="Noise filter" help="[noise] optional argument which is useful for data that was centroided without any intensity threshold, centroids with intensity smaller than ‘noise’ are omitted from ROI detection"/>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
132 </when>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
133 </conditional>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
134 </when>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
135
054e4681667c planemo upload
lecorguille
parents:
diff changeset
136 <!-- matched Filter options -->
054e4681667c planemo upload
lecorguille
parents:
diff changeset
137 <when value="matchedFilter">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
138 <param name="step" type="float" value="0.01" label="Step size to use for profile generation" help="[step] The peak detection algorithm creates extracted ion base peak chromatograms (EIBPC) on a fixed step size" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
139 <param name="fwhm" type="integer" value="30" label="Full width at half maximum of matched filtration gaussian model peak" help="[fwhm] Only used to calculate the actual sigma" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
140 <conditional name="options_m">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
141 <param name="option" type="select" label="Advanced options" >
054e4681667c planemo upload
lecorguille
parents:
diff changeset
142 <option value="show">show</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
143 <option value="hide" selected="true">hide</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
144 </param>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
145 <when value="show">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
146 <!--
054e4681667c planemo upload
lecorguille
parents:
diff changeset
147 <param name="sigma" type="hidden" value="fwhm/2.3548" label="sigma" help="standard deviation (fwhm/2.3548)" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
148 -->
054e4681667c planemo upload
lecorguille
parents:
diff changeset
149 <param name="max" type="integer" value="5" label="Maximum number of peaks per extracted ion chromatogram" help="[max]" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
150 <param name="snthresh" type="integer" value="10" label="Signal to noise ratio cutoff" help="[snthresh]" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
151 <param name="steps" type="integer" value="2" label="Number of steps to merge prior to filtration" help="[steps] The peak identification algorithm combines a given number of EIBPCs prior to filtration and peak detection, as defined by the steps argument" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
152 <!--
054e4681667c planemo upload
lecorguille
parents:
diff changeset
153 <param name="mzdiff" type="text" size="20" value="0.8-step*steps" label="m/z difference" help="min m/z difference for peaks with overlapping RT " />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
154 -->
054e4681667c planemo upload
lecorguille
parents:
diff changeset
155 </when>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
156 </conditional>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
157 </when>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
158
054e4681667c planemo upload
lecorguille
parents:
diff changeset
159 <!-- MSW Filter options -->
054e4681667c planemo upload
lecorguille
parents:
diff changeset
160 <when value="MSW">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
161 <param name="nearbyPeak" type="select" label="Determine whether to include the nearby small peaks of major peaks" help="[nearbyPeak]" >
054e4681667c planemo upload
lecorguille
parents:
diff changeset
162 <option value="TRUE">TRUE</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
163 <option value="FALSE">FALSE</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
164 </param>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
165 <param name="winSize_noise" type="integer" value="500" label="The local window size to estimate the noise level" help="[winSize.noise]" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
166 <param name="snthr" type="integer" value="3" label="SNR (Signal to Noise Ratio) threshold" help="[snthr]" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
167 <param name="amp_Th" type="float" value="0.002" label="Minimum required relative amplitude of the peak" help="[amp.Th] Ratio to the maximum of CWT coefficients" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
168 <param name="scales" type="text" value="seq(1,22,3)" label="Scales for the Continuous Wavelet Transform (CWT)" help="[scales] Scales are linked to the width of the peaks that are to be detected. Tape as indicaded seq('n,n,n') or c(n,n) : seq(from, to, by steps), c - linear vector " />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
169 <param name="SNR_method" type="text" value="data.mean" label="SNR (Signal to Noise Ratio) method" help="[SNR.method] Method to estimate noise level. Currently, only 95 percentage quantile is supported." />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
170 </when>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
171 </conditional>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
172 </inputs>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
173
054e4681667c planemo upload
lecorguille
parents:
diff changeset
174 <outputs>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
175 <data name="xsetRData" format="rdata.xcms.raw" label="xset.RData" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
176 <data name="sampleMetadata" format="tabular" label="sampleMetadata.tsv" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
177 <data name="ticsRawPdf" format="pdf" label="xset.TICs_raw.pdf" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
178 <data name="bpcsRawPdf" format="pdf" label="xset.BPCs_raw.pdf" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
179 <data name="log" format="txt" label="xset.log.txt" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
180 </outputs>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
181
054e4681667c planemo upload
lecorguille
parents:
diff changeset
182 <tests>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
183 <test>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
184 <param name="inputs.input" value="zip_file" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
185 <param name="inputs.zip_file" value="sacuri.zip" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
186 <param name="methods.method" value="matchedFilter" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
187 <param name="methods.step" value="0.01" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
188 <param name="methods.fwhm" value="4" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
189 <param name="methods.options_m.option" value="show" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
190 <param name="methods.options_m.max" value="50" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
191 <param name="methods.options_m.snthresh" value="1" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
192 <param name="methods.options_m.steps" value="2" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
193 <output name="xsetRData" file="xset.RData" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
194 <output name="sampleMetadata" file="sampleMetadata.tsv" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
195 <output name="ticsRawPdf" file="xset.TICs_raw.pdf" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
196 <output name="bpcsRawPdf" file="xset.BPCs_raw.pdf" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
197 <output name="log" file="xset.log.txt" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
198 </test>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
199 </tests>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
200
054e4681667c planemo upload
lecorguille
parents:
diff changeset
201 <help>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
202
054e4681667c planemo upload
lecorguille
parents:
diff changeset
203 .. class:: infomark
054e4681667c planemo upload
lecorguille
parents:
diff changeset
204
054e4681667c planemo upload
lecorguille
parents:
diff changeset
205 **Authors** Colin A. Smith csmith@scripps.edu, Ralf Tautenhahn rtautenh@gmail.com, Steffen Neumann sneumann@ipb-halle.de, Paul Benton hpaul.benton08@imperial.ac.uk and Christopher Conley cjconley@ucdavis.edu
054e4681667c planemo upload
lecorguille
parents:
diff changeset
206
054e4681667c planemo upload
lecorguille
parents:
diff changeset
207 .. class:: infomark
054e4681667c planemo upload
lecorguille
parents:
diff changeset
208
054e4681667c planemo upload
lecorguille
parents:
diff changeset
209 **Galaxy integration** ABiMS TEAM - UPMC/CNRS - Station biologique de Roscoff and Yann Guitton yann.guitton@univ-nantes.fr - part of Workflow4Metabolomics.org [W4M]
054e4681667c planemo upload
lecorguille
parents:
diff changeset
210
054e4681667c planemo upload
lecorguille
parents:
diff changeset
211 | Contact support@workflow4metabolomics.org for any questions or concerns about the Galaxy implementation of this tool.
054e4681667c planemo upload
lecorguille
parents:
diff changeset
212
054e4681667c planemo upload
lecorguille
parents:
diff changeset
213 ---------------------------------------------------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
214
054e4681667c planemo upload
lecorguille
parents:
diff changeset
215 ============
054e4681667c planemo upload
lecorguille
parents:
diff changeset
216 Xcms.xcmsSet
054e4681667c planemo upload
lecorguille
parents:
diff changeset
217 ============
054e4681667c planemo upload
lecorguille
parents:
diff changeset
218
054e4681667c planemo upload
lecorguille
parents:
diff changeset
219 -----------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
220 Description
054e4681667c planemo upload
lecorguille
parents:
diff changeset
221 -----------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
222
054e4681667c planemo upload
lecorguille
parents:
diff changeset
223 This tool is used for preprocessing analyte data from multiple LC/MS files (formats NetCDF, mzXML and mzData). It extracts ion from each sample independently and using a statistic model, peaks are filtered and integrated.
054e4681667c planemo upload
lecorguille
parents:
diff changeset
224 You can read a tutorial on how to perform xcms preprocessing which is available here_.
054e4681667c planemo upload
lecorguille
parents:
diff changeset
225
054e4681667c planemo upload
lecorguille
parents:
diff changeset
226 .. _here: http://web11.sb-roscoff.fr/download/w4m/howto/w4m_HowToPerformXcmsPreprocessing_v02.pdf
054e4681667c planemo upload
lecorguille
parents:
diff changeset
227
054e4681667c planemo upload
lecorguille
parents:
diff changeset
228
054e4681667c planemo upload
lecorguille
parents:
diff changeset
229 -----------------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
230 Workflow position
054e4681667c planemo upload
lecorguille
parents:
diff changeset
231 -----------------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
232
054e4681667c planemo upload
lecorguille
parents:
diff changeset
233 **Upstream tools**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
234
054e4681667c planemo upload
lecorguille
parents:
diff changeset
235 ========================= ================= ======= =========
054e4681667c planemo upload
lecorguille
parents:
diff changeset
236 Name output file format parameter
054e4681667c planemo upload
lecorguille
parents:
diff changeset
237 ========================= ================= ======= =========
054e4681667c planemo upload
lecorguille
parents:
diff changeset
238 NA NA zip NA
054e4681667c planemo upload
lecorguille
parents:
diff changeset
239 ========================= ================= ======= =========
054e4681667c planemo upload
lecorguille
parents:
diff changeset
240
054e4681667c planemo upload
lecorguille
parents:
diff changeset
241
054e4681667c planemo upload
lecorguille
parents:
diff changeset
242 **Downstream tools**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
243
054e4681667c planemo upload
lecorguille
parents:
diff changeset
244 +---------------------------+--------------------+-----------------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
245 | Name | Output file | Format |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
246 +===========================+====================+=================+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
247 |xcms.group | xset.RData | rdata.xcms.raw |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
248 +---------------------------+--------------------+-----------------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
249 |PCA ellipsoid by factors | sampleMetadata.tsv | Tabular |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
250 +---------------------------+--------------------+-----------------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
251 |Anova | sampleMetadata.tsv | Tabular |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
252 +---------------------------+--------------------+-----------------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
253
054e4681667c planemo upload
lecorguille
parents:
diff changeset
254
054e4681667c planemo upload
lecorguille
parents:
diff changeset
255 **Example of a metabolomic workflow**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
256
054e4681667c planemo upload
lecorguille
parents:
diff changeset
257 .. image:: XCMS_Galaxy_workflow.png
054e4681667c planemo upload
lecorguille
parents:
diff changeset
258
054e4681667c planemo upload
lecorguille
parents:
diff changeset
259
054e4681667c planemo upload
lecorguille
parents:
diff changeset
260 ------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
261
054e4681667c planemo upload
lecorguille
parents:
diff changeset
262 .. class:: infomark
054e4681667c planemo upload
lecorguille
parents:
diff changeset
263
054e4681667c planemo upload
lecorguille
parents:
diff changeset
264 The output file is an xset.RData file. You can continue your analysis using it in **xcms.group** tool.
054e4681667c planemo upload
lecorguille
parents:
diff changeset
265
054e4681667c planemo upload
lecorguille
parents:
diff changeset
266 ---------------------------------------------------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
267
054e4681667c planemo upload
lecorguille
parents:
diff changeset
268
054e4681667c planemo upload
lecorguille
parents:
diff changeset
269
054e4681667c planemo upload
lecorguille
parents:
diff changeset
270 -----------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
271 Input files
054e4681667c planemo upload
lecorguille
parents:
diff changeset
272 -----------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
273
054e4681667c planemo upload
lecorguille
parents:
diff changeset
274 +---------------------------+------------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
275 | Parameter : num + label | Format |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
276 +===========================+============+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
277 | 1 : Choose your inputs | zip |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
278 +---------------------------+------------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
279
054e4681667c planemo upload
lecorguille
parents:
diff changeset
280 **Choose your inputs**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
281
054e4681667c planemo upload
lecorguille
parents:
diff changeset
282 You have two methods for your inputs:
054e4681667c planemo upload
lecorguille
parents:
diff changeset
283
054e4681667c planemo upload
lecorguille
parents:
diff changeset
284 | Zip file (recommended): You can put a zip file containing your inputs: myinputs.zip (containing all your conditions as sub-directories).
054e4681667c planemo upload
lecorguille
parents:
diff changeset
285 | library folder: You must specify the name of your "library" (folder) created within your space project (for example: /projet/externe/institut/login/galaxylibrary/yourlibrary). Your library must contain all your conditions as sub-directories.
054e4681667c planemo upload
lecorguille
parents:
diff changeset
286
054e4681667c planemo upload
lecorguille
parents:
diff changeset
287 ----------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
288 Parameters
054e4681667c planemo upload
lecorguille
parents:
diff changeset
289 ----------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
290
054e4681667c planemo upload
lecorguille
parents:
diff changeset
291 Extraction method for peaks detection
054e4681667c planemo upload
lecorguille
parents:
diff changeset
292 -------------------------------------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
293
054e4681667c planemo upload
lecorguille
parents:
diff changeset
294 **Matched Filter**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
295
054e4681667c planemo upload
lecorguille
parents:
diff changeset
296 | One parameter to consider is the Gaussian model peak width used for matched filtration,an integral part of the peak detection algorithm.
054e4681667c planemo upload
lecorguille
parents:
diff changeset
297 | For a discussion of how model peak width affects the signal to noise ratio, see Danielsson et al. (2002).
054e4681667c planemo upload
lecorguille
parents:
diff changeset
298
054e4681667c planemo upload
lecorguille
parents:
diff changeset
299
054e4681667c planemo upload
lecorguille
parents:
diff changeset
300 **cent Wave**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
301
054e4681667c planemo upload
lecorguille
parents:
diff changeset
302 | This algorithm is most suitable for high resolution LC/{TOF,OrbiTrap,FTICR}-MS data in centroid mode.
054e4681667c planemo upload
lecorguille
parents:
diff changeset
303 | Due to the fact that peak centroids are used, a binning step is not necessary.
054e4681667c planemo upload
lecorguille
parents:
diff changeset
304 | The method is capable of detecting close-by-peaks and also overlapping peaks. Some efforts are made to detect the exact peak boundaries to get precise peak integrals.
054e4681667c planemo upload
lecorguille
parents:
diff changeset
305
054e4681667c planemo upload
lecorguille
parents:
diff changeset
306 **MSW**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
307
054e4681667c planemo upload
lecorguille
parents:
diff changeset
308 | Wavelet based, used for direct infusion data. Continuous wavelet transform (CWT) can be used to locate chromatographic peaks on different scales.
054e4681667c planemo upload
lecorguille
parents:
diff changeset
309 | If you wish to have more details about the other parameters, you can read the following documents:
054e4681667c planemo upload
lecorguille
parents:
diff changeset
310 | -Example of preprocessing data with XCMS : http://www.bioconductor.org/packages/2.12/bioc/vignettes/xcms/inst/doc/xcmsPreprocess.pdf
054e4681667c planemo upload
lecorguille
parents:
diff changeset
311 | -Details and explanations for all the parameters of XCMS package: http://www.bioconductor.org/packages/release/bioc/manuals/xcms/man/xcms.pdf
054e4681667c planemo upload
lecorguille
parents:
diff changeset
312
054e4681667c planemo upload
lecorguille
parents:
diff changeset
313
054e4681667c planemo upload
lecorguille
parents:
diff changeset
314 ------------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
315 Output files
054e4681667c planemo upload
lecorguille
parents:
diff changeset
316 ------------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
317
054e4681667c planemo upload
lecorguille
parents:
diff changeset
318 xset.TICs_raw.pdf
054e4681667c planemo upload
lecorguille
parents:
diff changeset
319
054e4681667c planemo upload
lecorguille
parents:
diff changeset
320 | "Total Ion Chromatograms" graph in pdf format.
054e4681667c planemo upload
lecorguille
parents:
diff changeset
321
054e4681667c planemo upload
lecorguille
parents:
diff changeset
322 xset.BPCs_raw.pdf
054e4681667c planemo upload
lecorguille
parents:
diff changeset
323
054e4681667c planemo upload
lecorguille
parents:
diff changeset
324 | "Base Peak Chromatograms" graph in pdf format with each class samples opposed.
054e4681667c planemo upload
lecorguille
parents:
diff changeset
325
054e4681667c planemo upload
lecorguille
parents:
diff changeset
326 sampleMetadata.tsv
054e4681667c planemo upload
lecorguille
parents:
diff changeset
327
054e4681667c planemo upload
lecorguille
parents:
diff changeset
328 | Tabular file that contains for each sample, it's associated class and polarity (positive,negative and mixed).
054e4681667c planemo upload
lecorguille
parents:
diff changeset
329 | This file is necessary in the Anova and PCA step of the workflow.
054e4681667c planemo upload
lecorguille
parents:
diff changeset
330
054e4681667c planemo upload
lecorguille
parents:
diff changeset
331 xset.RData: rdata.xcms.raw format
054e4681667c planemo upload
lecorguille
parents:
diff changeset
332
054e4681667c planemo upload
lecorguille
parents:
diff changeset
333 | Rdata file that is necessary in the second step of the workflow "xcms.group".
054e4681667c planemo upload
lecorguille
parents:
diff changeset
334
054e4681667c planemo upload
lecorguille
parents:
diff changeset
335 ------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
336
054e4681667c planemo upload
lecorguille
parents:
diff changeset
337 .. class:: infomark
054e4681667c planemo upload
lecorguille
parents:
diff changeset
338
054e4681667c planemo upload
lecorguille
parents:
diff changeset
339 The output file is an xset.RData file. You can continue your analysis using it in **xcms.group** tool.
054e4681667c planemo upload
lecorguille
parents:
diff changeset
340
054e4681667c planemo upload
lecorguille
parents:
diff changeset
341 ---------------------------------------------------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
342
054e4681667c planemo upload
lecorguille
parents:
diff changeset
343 ---------------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
344 Working example
054e4681667c planemo upload
lecorguille
parents:
diff changeset
345 ---------------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
346
054e4681667c planemo upload
lecorguille
parents:
diff changeset
347 Input files
054e4681667c planemo upload
lecorguille
parents:
diff changeset
348 -----------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
349
054e4681667c planemo upload
lecorguille
parents:
diff changeset
350 | zip_file -> **sacuri.zip**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
351
054e4681667c planemo upload
lecorguille
parents:
diff changeset
352 Parameters
054e4681667c planemo upload
lecorguille
parents:
diff changeset
353 ----------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
354
054e4681667c planemo upload
lecorguille
parents:
diff changeset
355 | Method -> **matchedFilter**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
356 | step -> **0.01**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
357 | fwhm -> **4**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
358 | Advanced option -> **show**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
359 | max: -> **50**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
360 | snthresh -> **1**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
361 | steps -> **2**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
362
054e4681667c planemo upload
lecorguille
parents:
diff changeset
363
054e4681667c planemo upload
lecorguille
parents:
diff changeset
364 Output files
054e4681667c planemo upload
lecorguille
parents:
diff changeset
365 ------------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
366
054e4681667c planemo upload
lecorguille
parents:
diff changeset
367 | **1) xset.RData: RData file**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
368
054e4681667c planemo upload
lecorguille
parents:
diff changeset
369 | **2) Example of a sampleMetadata.tsv :**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
370
054e4681667c planemo upload
lecorguille
parents:
diff changeset
371
054e4681667c planemo upload
lecorguille
parents:
diff changeset
372 +---------------------------+------------+---------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
373 | sampleMetadata | class | polarity|
054e4681667c planemo upload
lecorguille
parents:
diff changeset
374 +===========================+============+=========+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
375 |HU_neg_017 | bio |negative |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
376 +---------------------------+------------+---------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
377 |HU_neg_028 | bio |negative |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
378 +---------------------------+------------+---------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
379 |HU_neg_034 | bio |negative |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
380 +---------------------------+------------+---------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
381 |Blanc04 | blank |negative |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
382 +---------------------------+------------+---------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
383 |Blanc06 | blank |negative |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
384 +---------------------------+------------+---------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
385 |Blanc09 | blank |negative |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
386 +---------------------------+------------+---------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
387
054e4681667c planemo upload
lecorguille
parents:
diff changeset
388
054e4681667c planemo upload
lecorguille
parents:
diff changeset
389
054e4681667c planemo upload
lecorguille
parents:
diff changeset
390 | **3) Example of xset.TICs_raw.pdf (Total Ion Chromatograms) :**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
391
054e4681667c planemo upload
lecorguille
parents:
diff changeset
392 .. image:: xcms_tics.png
054e4681667c planemo upload
lecorguille
parents:
diff changeset
393
054e4681667c planemo upload
lecorguille
parents:
diff changeset
394
4
c5fa73f1703f Uploaded
mmonsoor
parents: 0
diff changeset
395
0
054e4681667c planemo upload
lecorguille
parents:
diff changeset
396 </help>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
397
054e4681667c planemo upload
lecorguille
parents:
diff changeset
398
054e4681667c planemo upload
lecorguille
parents:
diff changeset
399 <citations>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
400 <citation type="doi">10.1021/ac051437y</citation>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
401 <citation type="doi">10.1093/bioinformatics/btu813</citation>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
402 </citations>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
403
054e4681667c planemo upload
lecorguille
parents:
diff changeset
404 </tool>