annotate abims_xcms_xcmsSet.xml @ 9:5590b80e6e13 draft

planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 2aff6f6ced8185ed35371d7ad637e5a44f8a250c
author lecorguille
date Mon, 04 Jul 2016 11:54:47 -0400
parents 451ff602a957
children 69eb0fc05837
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
1 <tool id="abims_xcms_xcmsSet" name="xcms.xcmsSet" version="2.0.8">
0
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
6
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
5 <macros>
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
6 <import>macros.xml</import>
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
7 </macros>
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
8
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
9 <expand macro="requirements"/>
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
10 <expand macro="stdio"/>
0
054e4681667c planemo upload
lecorguille
parents:
diff changeset
11
5
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
12 <command><![CDATA[
6
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
13 @COMMAND_XCMS_SCRIPT@
0
054e4681667c planemo upload
lecorguille
parents:
diff changeset
14 #if $inputs.input == "lib":
054e4681667c planemo upload
lecorguille
parents:
diff changeset
15 library $__app__.config.user_library_import_dir/$__user_email__/$inputs.library
054e4681667c planemo upload
lecorguille
parents:
diff changeset
16 #elif $inputs.input == "zip_file":
054e4681667c planemo upload
lecorguille
parents:
diff changeset
17 zipfile $inputs.zip_file
054e4681667c planemo upload
lecorguille
parents:
diff changeset
18 #end if
054e4681667c planemo upload
lecorguille
parents:
diff changeset
19
054e4681667c planemo upload
lecorguille
parents:
diff changeset
20 xfunction xcmsSet
5
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
21
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
22 xsetRdataOutput $xsetRData
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
23 sampleMetadataOutput $sampleMetadata
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
24 ticspdf $ticsRawPdf
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
25 bicspdf $bpcsRawPdf
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
26
0
054e4681667c planemo upload
lecorguille
parents:
diff changeset
27 ## profmethod $profmethod
054e4681667c planemo upload
lecorguille
parents:
diff changeset
28 nSlaves \${GALAXY_SLOTS:-1} method $methods.method
054e4681667c planemo upload
lecorguille
parents:
diff changeset
29 #if $methods.method == "centWave":
054e4681667c planemo upload
lecorguille
parents:
diff changeset
30 ppm $methods.ppm
054e4681667c planemo upload
lecorguille
parents:
diff changeset
31 peakwidth "c($methods.peakwidth)"
6
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
32 #if $methods.options_scanrange.option == "show":
0
054e4681667c planemo upload
lecorguille
parents:
diff changeset
33 scanrange "c($methods.options_scanrange.scanrange)"
6
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
34 #end if
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
35 #if $methods.options_c.option == "show":
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
36 mzdiff $methods.options_c.mzdiff
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
37 snthresh $methods.options_c.snthresh
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
38 integrate $methods.options_c.integrate
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
39 noise $methods.options_c.noise
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
40 prefilter "c($methods.options_c.prefilter)"
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
41 #end if
0
054e4681667c planemo upload
lecorguille
parents:
diff changeset
42 #elif $methods.method == "matchedFilter":
054e4681667c planemo upload
lecorguille
parents:
diff changeset
43 step $methods.step
054e4681667c planemo upload
lecorguille
parents:
diff changeset
44 fwhm $methods.fwhm
054e4681667c planemo upload
lecorguille
parents:
diff changeset
45 #if $methods.options_m.option == "show":
054e4681667c planemo upload
lecorguille
parents:
diff changeset
46 ## sigma "$methods.options_m.sigma"
054e4681667c planemo upload
lecorguille
parents:
diff changeset
47 max $methods.options_m.max
054e4681667c planemo upload
lecorguille
parents:
diff changeset
48 snthresh $methods.options_m.snthresh
054e4681667c planemo upload
lecorguille
parents:
diff changeset
49 ## mzdiff $methods.options_m.mzdiff
054e4681667c planemo upload
lecorguille
parents:
diff changeset
50 steps $methods.options_m.steps
054e4681667c planemo upload
lecorguille
parents:
diff changeset
51 ## sleep $methods.options_m.sleep
054e4681667c planemo upload
lecorguille
parents:
diff changeset
52 #end if
054e4681667c planemo upload
lecorguille
parents:
diff changeset
53 #elif $methods.method == "MSW":
054e4681667c planemo upload
lecorguille
parents:
diff changeset
54 snthr $methods.snthr
054e4681667c planemo upload
lecorguille
parents:
diff changeset
55 nearbyPeak $methods.nearbyPeak
054e4681667c planemo upload
lecorguille
parents:
diff changeset
56 winSize.noise $methods.winSize_noise
054e4681667c planemo upload
lecorguille
parents:
diff changeset
57 amp.Th $methods.amp_Th
054e4681667c planemo upload
lecorguille
parents:
diff changeset
58 scales "c($methods.scales)"
054e4681667c planemo upload
lecorguille
parents:
diff changeset
59 SNR.method "$methods.SNR_method"
054e4681667c planemo upload
lecorguille
parents:
diff changeset
60 #end if
6
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
61 @COMMAND_LOG_EXIT@
5
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
62 ]]></command>
0
054e4681667c planemo upload
lecorguille
parents:
diff changeset
63
054e4681667c planemo upload
lecorguille
parents:
diff changeset
64 <inputs>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
65
054e4681667c planemo upload
lecorguille
parents:
diff changeset
66 <conditional name="inputs">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
67 <param name="input" type="select" label="Choose your inputs method" >
054e4681667c planemo upload
lecorguille
parents:
diff changeset
68 <option value="zip_file" selected="true">Zip file from your history containing your chromatograms</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
69 <option value="lib" >Library directory name</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
70 </param>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
71 <when value="zip_file">
5
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
72 <param name="zip_file" type="data" format="no_unzip.zip,zip" label="Zip file" />
0
054e4681667c planemo upload
lecorguille
parents:
diff changeset
73 </when>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
74 <when value="lib">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
75 <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
76 <validator type="empty_field"/>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
77 </param>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
78 </when>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
79
054e4681667c planemo upload
lecorguille
parents:
diff changeset
80 </conditional>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
81
054e4681667c planemo upload
lecorguille
parents:
diff changeset
82
054e4681667c planemo upload
lecorguille
parents:
diff changeset
83 <!--
054e4681667c planemo upload
lecorguille
parents:
diff changeset
84 <param name="profmethod" type="select" label="Method to use for profile generation (profmethod)" >
054e4681667c planemo upload
lecorguille
parents:
diff changeset
85 <option value="bin" selected="true">bin</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
86 <option value="binlin">binlin</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
87 <option value="binlinbase">binlinbase</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
88 <option value="intlin">intlin</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
89 </param>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
90 <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
91 -->
054e4681667c planemo upload
lecorguille
parents:
diff changeset
92 <conditional name="methods">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
93 <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
94 <option value="centWave" >centWave</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
95 <option value="matchedFilter" selected="true">matchedFilter</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
96 <option value="MSW">MSW</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
97 </param>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
98
054e4681667c planemo upload
lecorguille
parents:
diff changeset
99 <!-- centWave Filter options -->
054e4681667c planemo upload
lecorguille
parents:
diff changeset
100 <when value="centWave">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
101 <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
102 <param name="peakwidth" type="text" value="20,50" label="Min,Max peak width in seconds" help="[peakwidth]" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
103 <conditional name="options_scanrange">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
104 <param name="option" type="select" label="Scan range option " >
054e4681667c planemo upload
lecorguille
parents:
diff changeset
105 <option value="show">show</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
106 <option value="hide" selected="true">hide</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
107 </param>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
108 <when value="show">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
109 <param name="scanrange" type="text" value="" label="scanrange" help="scan range to process, for example (16,365)" >
054e4681667c planemo upload
lecorguille
parents:
diff changeset
110 <validator type="empty_field"/>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
111 </param>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
112 </when>
5
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
113 <when value="hide">
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
114 </when>
0
054e4681667c planemo upload
lecorguille
parents:
diff changeset
115 </conditional>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
116
054e4681667c planemo upload
lecorguille
parents:
diff changeset
117 <conditional name="options_c">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
118 <param name="option" type="select" label="Advanced options" >
054e4681667c planemo upload
lecorguille
parents:
diff changeset
119 <option value="show">show</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
120 <option value="hide" selected="true">hide</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
121 </param>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
122 <when value="show">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
123 <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
124 <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
125 <param name="integrate" type="select" label="peak limits method" help="[integrate]" >
054e4681667c planemo upload
lecorguille
parents:
diff changeset
126 <option value="1">peak limits based on smoothed 2nd derivative (less precise)</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
127 <option value="2">peak limits based on real data (more sensitive to noise)</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
128 </param>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
129 <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
130 <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
131 </when>
5
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
132 <when value="hide">
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
133 </when>
0
054e4681667c planemo upload
lecorguille
parents:
diff changeset
134 </conditional>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
135 </when>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
136
054e4681667c planemo upload
lecorguille
parents:
diff changeset
137 <!-- matched Filter options -->
054e4681667c planemo upload
lecorguille
parents:
diff changeset
138 <when value="matchedFilter">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
139 <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
140 <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
141 <conditional name="options_m">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
142 <param name="option" type="select" label="Advanced options" >
054e4681667c planemo upload
lecorguille
parents:
diff changeset
143 <option value="show">show</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
144 <option value="hide" selected="true">hide</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
145 </param>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
146 <when value="show">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
147 <!--
054e4681667c planemo upload
lecorguille
parents:
diff changeset
148 <param name="sigma" type="hidden" value="fwhm/2.3548" label="sigma" help="standard deviation (fwhm/2.3548)" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
149 -->
054e4681667c planemo upload
lecorguille
parents:
diff changeset
150 <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
151 <param name="snthresh" type="integer" value="10" label="Signal to noise ratio cutoff" help="[snthresh]" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
152 <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
153 <!--
054e4681667c planemo upload
lecorguille
parents:
diff changeset
154 <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
155 -->
054e4681667c planemo upload
lecorguille
parents:
diff changeset
156 </when>
5
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
157 <when value="hide">
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
158 </when>
0
054e4681667c planemo upload
lecorguille
parents:
diff changeset
159 </conditional>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
160 </when>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
161
054e4681667c planemo upload
lecorguille
parents:
diff changeset
162 <!-- MSW Filter options -->
054e4681667c planemo upload
lecorguille
parents:
diff changeset
163 <when value="MSW">
054e4681667c planemo upload
lecorguille
parents:
diff changeset
164 <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
165 <option value="TRUE">TRUE</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
166 <option value="FALSE">FALSE</option>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
167 </param>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
168 <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
169 <param name="snthr" type="integer" value="3" label="SNR (Signal to Noise Ratio) threshold" help="[snthr]" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
170 <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
171 <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
172 <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
173 </when>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
174 </conditional>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
175 </inputs>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
176
054e4681667c planemo upload
lecorguille
parents:
diff changeset
177 <outputs>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
178 <data name="xsetRData" format="rdata.xcms.raw" label="xset.RData" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
179 <data name="sampleMetadata" format="tabular" label="sampleMetadata.tsv" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
180 <data name="ticsRawPdf" format="pdf" label="xset.TICs_raw.pdf" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
181 <data name="bpcsRawPdf" format="pdf" label="xset.BPCs_raw.pdf" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
182 <data name="log" format="txt" label="xset.log.txt" />
054e4681667c planemo upload
lecorguille
parents:
diff changeset
183 </outputs>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
184
054e4681667c planemo upload
lecorguille
parents:
diff changeset
185 <tests>
7
451ff602a957 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents: 6
diff changeset
186 <!--<test>
6
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
187 <param name="inputs|input" value="zip_file" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
188 <param name="inputs|zip_file" value="sacuri_dir_root.zip" ftype="zip" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
189 <param name="methods|method" value="matchedFilter" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
190 <param name="methods|step" value="0.01" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
191 <param name="methods|fwhm" value="4" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
192 <param name="methods|options_m|option" value="show" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
193 <param name="methods|options_m|max" value="50" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
194 <param name="methods|options_m|snthresh" value="1" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
195 <param name="methods|options_m|steps" value="2" />
5
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
196 <output name="log">
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
197 <assert_contents>
6
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
198 <has_text text="object with 4 samples" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
199 <has_text text="Time range: 0.7-1139.7 seconds (0-19 minutes)" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
200 <has_text text="Mass range: 50.0021-999.9863 m/z" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
201 <has_text text="Peaks: 59359 (about 14840 per sample)" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
202 <has_text text="Peak Groups: 0" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
203 <has_text text="Sample classes: bio, blank" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
204 </assert_contents>
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
205 </output>
7
451ff602a957 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents: 6
diff changeset
206 </test>
6
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
207 <test>
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
208 <param name="inputs|input" value="zip_file" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
209 <param name="inputs|zip_file" value="sacuri_current_root.zip" ftype="zip" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
210 <param name="methods|method" value="centWave" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
211 <param name="methods|ppm" value="25" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
212 <param name="methods|peakwidth" value="20,50" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
213 <output name="log">
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
214 <assert_contents>
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
215 <has_text text="object with 4 samples" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
216 <has_text text="Time range: 3.5-1139.2 seconds (0.1-19 minutes)" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
217 <has_text text="Mass range: 57.9756-593.4086 m/z" />
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
218 <has_text text="Peaks: 1535 (about 384 per sample)" />
5
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
219 <has_text text="Peak Groups: 0" />
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
220 <has_text text="Sample classes: bio, blank" />
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
221 </assert_contents>
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
222 </output>
7
451ff602a957 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents: 6
diff changeset
223 </test>-->
451ff602a957 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents: 6
diff changeset
224 <test>
451ff602a957 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents: 6
diff changeset
225 <param name="inputs|input" value="zip_file" />
451ff602a957 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents: 6
diff changeset
226 <param name="inputs|zip_file" value="faahKO_reduce.zip" ftype="zip" />
451ff602a957 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents: 6
diff changeset
227 <param name="methods|method" value="centWave" />
451ff602a957 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents: 6
diff changeset
228 <param name="methods|ppm" value="25" />
451ff602a957 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents: 6
diff changeset
229 <param name="methods|peakwidth" value="20,50" />
451ff602a957 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents: 6
diff changeset
230 <output name="log">
451ff602a957 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents: 6
diff changeset
231 <assert_contents>
451ff602a957 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents: 6
diff changeset
232 <has_text text="object with 4 samples" />
451ff602a957 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents: 6
diff changeset
233 <has_text text="Time range: 2506.1-4477.9 seconds (41.8-74.6 minutes)" />
451ff602a957 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents: 6
diff changeset
234 <has_text text="Mass range: 200.1-600 m/z" />
451ff602a957 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents: 6
diff changeset
235 <has_text text="Peaks: 9251 (about 2313 per sample)" />
451ff602a957 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents: 6
diff changeset
236 <has_text text="Peak Groups: 0" />
451ff602a957 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents: 6
diff changeset
237 <has_text text="Sample classes: KO, WT" />
451ff602a957 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents: 6
diff changeset
238 </assert_contents>
451ff602a957 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents: 6
diff changeset
239 </output>
0
054e4681667c planemo upload
lecorguille
parents:
diff changeset
240 </test>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
241 </tests>
054e4681667c planemo upload
lecorguille
parents:
diff changeset
242
5
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
243 <help><![CDATA[
0
054e4681667c planemo upload
lecorguille
parents:
diff changeset
244
6
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
245 @HELP_AUTHORS@
0
054e4681667c planemo upload
lecorguille
parents:
diff changeset
246
054e4681667c planemo upload
lecorguille
parents:
diff changeset
247 ============
054e4681667c planemo upload
lecorguille
parents:
diff changeset
248 Xcms.xcmsSet
054e4681667c planemo upload
lecorguille
parents:
diff changeset
249 ============
054e4681667c planemo upload
lecorguille
parents:
diff changeset
250
054e4681667c planemo upload
lecorguille
parents:
diff changeset
251 -----------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
252 Description
054e4681667c planemo upload
lecorguille
parents:
diff changeset
253 -----------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
254
054e4681667c planemo upload
lecorguille
parents:
diff changeset
255 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
256 You can read a tutorial on how to perform xcms preprocessing which is available here_.
054e4681667c planemo upload
lecorguille
parents:
diff changeset
257
054e4681667c planemo upload
lecorguille
parents:
diff changeset
258 .. _here: http://web11.sb-roscoff.fr/download/w4m/howto/w4m_HowToPerformXcmsPreprocessing_v02.pdf
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 Workflow position
054e4681667c planemo upload
lecorguille
parents:
diff changeset
263 -----------------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
264
054e4681667c planemo upload
lecorguille
parents:
diff changeset
265 **Upstream tools**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
266
054e4681667c planemo upload
lecorguille
parents:
diff changeset
267 ========================= ================= ======= =========
054e4681667c planemo upload
lecorguille
parents:
diff changeset
268 Name output file format parameter
054e4681667c planemo upload
lecorguille
parents:
diff changeset
269 ========================= ================= ======= =========
054e4681667c planemo upload
lecorguille
parents:
diff changeset
270 NA NA zip NA
054e4681667c planemo upload
lecorguille
parents:
diff changeset
271 ========================= ================= ======= =========
054e4681667c planemo upload
lecorguille
parents:
diff changeset
272
054e4681667c planemo upload
lecorguille
parents:
diff changeset
273
054e4681667c planemo upload
lecorguille
parents:
diff changeset
274 **Downstream tools**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
275
054e4681667c planemo upload
lecorguille
parents:
diff changeset
276 +---------------------------+--------------------+-----------------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
277 | Name | Output file | Format |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
278 +===========================+====================+=================+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
279 |xcms.group | xset.RData | rdata.xcms.raw |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
280 +---------------------------+--------------------+-----------------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
281 |PCA ellipsoid by factors | sampleMetadata.tsv | Tabular |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
282 +---------------------------+--------------------+-----------------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
283 |Anova | sampleMetadata.tsv | Tabular |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
284 +---------------------------+--------------------+-----------------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
285
054e4681667c planemo upload
lecorguille
parents:
diff changeset
286
054e4681667c planemo upload
lecorguille
parents:
diff changeset
287 **Example of a metabolomic workflow**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
288
054e4681667c planemo upload
lecorguille
parents:
diff changeset
289 .. image:: XCMS_Galaxy_workflow.png
054e4681667c planemo upload
lecorguille
parents:
diff changeset
290
054e4681667c planemo upload
lecorguille
parents:
diff changeset
291
054e4681667c planemo upload
lecorguille
parents:
diff changeset
292 ------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
293
054e4681667c planemo upload
lecorguille
parents:
diff changeset
294 .. class:: infomark
054e4681667c planemo upload
lecorguille
parents:
diff changeset
295
054e4681667c planemo upload
lecorguille
parents:
diff changeset
296 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
297
054e4681667c planemo upload
lecorguille
parents:
diff changeset
298 ---------------------------------------------------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
299
054e4681667c planemo upload
lecorguille
parents:
diff changeset
300
054e4681667c planemo upload
lecorguille
parents:
diff changeset
301
054e4681667c planemo upload
lecorguille
parents:
diff changeset
302 -----------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
303 Input files
054e4681667c planemo upload
lecorguille
parents:
diff changeset
304 -----------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
305
054e4681667c planemo upload
lecorguille
parents:
diff changeset
306 +---------------------------+------------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
307 | Parameter : num + label | Format |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
308 +===========================+============+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
309 | 1 : Choose your inputs | zip |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
310 +---------------------------+------------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
311
054e4681667c planemo upload
lecorguille
parents:
diff changeset
312 **Choose your inputs**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
313
054e4681667c planemo upload
lecorguille
parents:
diff changeset
314 You have two methods for your inputs:
054e4681667c planemo upload
lecorguille
parents:
diff changeset
315
054e4681667c planemo upload
lecorguille
parents:
diff changeset
316 | 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
317 | 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
318
5
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
319 Steps for creating the zip file
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
320 -------------------------------
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
321
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
322 **Step1: Creating your directory and hierarchize the subdirectories**
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
323
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
324
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
325 VERY IMPORTANT: If you zip your files under Windows, you must use the 7Zip software (http://www.7-zip.org/), otherwise your zip will not be well unzipped on the platform W4M (zip corrupted bug).
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
326
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
327 Your zip should contain all your conditions as sub-directories. For example, two conditions (mutant and wild):
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
328 arabidopsis/wild/01.raw
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
329 arabidopsis/mutant/01.raw
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
330
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
331 **Step2: Creating a zip file**
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
332
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
333 Create your zip file (e.g.: arabidopsis.zip).
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
334
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
335 **Step 3 : Uploading it to our Galaxy server**
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
336
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
337 If your zip file is less than 2Gb, you get use the Get Data tool to upload it.
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
338
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
339 Otherwise if your zip file is larger than 2Gb, please refer to the HOWTO on workflow4metabolomics.org (http://application.sb-roscoff.fr/download/w4m/howto/galaxy_upload_up_2Go.pdf).
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
340
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
341 For more informations, don't hesitate to send us an email at supportATworkflow4metabolomics.org).
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
342
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
343 Advices for converting your files for the XCMS input
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
344 ----------------------------------------------------
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
345
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
346 We recommend you to convert your raw files to **mzXML** in centroid mode (smaller files) and the files will be compatible with the xmcs centWave method.
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
347
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
348 **We recommend you the following parameters:**
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
349
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
350 Use Filtering: **True**
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
351
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
352 Use Peak Picking: **True**
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
353
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
354 Peak Peaking -Apply to MS Levels: **All Levels (1-)** : Centroid Mode
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
355
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
356 Use zlib: **64**
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
357
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
358 Binary Encoding: **64**
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
359
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
360 m/z Encoding: **64**
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
361
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
362 Intensity Encoding: **64**
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
363
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
364
0
054e4681667c planemo upload
lecorguille
parents:
diff changeset
365 ----------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
366 Parameters
054e4681667c planemo upload
lecorguille
parents:
diff changeset
367 ----------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
368
054e4681667c planemo upload
lecorguille
parents:
diff changeset
369 Extraction method for peaks detection
054e4681667c planemo upload
lecorguille
parents:
diff changeset
370 -------------------------------------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
371
054e4681667c planemo upload
lecorguille
parents:
diff changeset
372 **Matched Filter**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
373
054e4681667c planemo upload
lecorguille
parents:
diff changeset
374 | 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
375 | 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
376
054e4681667c planemo upload
lecorguille
parents:
diff changeset
377
054e4681667c planemo upload
lecorguille
parents:
diff changeset
378 **cent Wave**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
379
054e4681667c planemo upload
lecorguille
parents:
diff changeset
380 | This algorithm is most suitable for high resolution LC/{TOF,OrbiTrap,FTICR}-MS data in centroid mode.
054e4681667c planemo upload
lecorguille
parents:
diff changeset
381 | Due to the fact that peak centroids are used, a binning step is not necessary.
054e4681667c planemo upload
lecorguille
parents:
diff changeset
382 | 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
383
054e4681667c planemo upload
lecorguille
parents:
diff changeset
384 **MSW**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
385
054e4681667c planemo upload
lecorguille
parents:
diff changeset
386 | 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
387 | If you wish to have more details about the other parameters, you can read the following documents:
054e4681667c planemo upload
lecorguille
parents:
diff changeset
388 | -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
389 | -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
390
054e4681667c planemo upload
lecorguille
parents:
diff changeset
391
054e4681667c planemo upload
lecorguille
parents:
diff changeset
392 ------------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
393 Output files
054e4681667c planemo upload
lecorguille
parents:
diff changeset
394 ------------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
395
054e4681667c planemo upload
lecorguille
parents:
diff changeset
396 xset.TICs_raw.pdf
054e4681667c planemo upload
lecorguille
parents:
diff changeset
397
054e4681667c planemo upload
lecorguille
parents:
diff changeset
398 | "Total Ion Chromatograms" graph in pdf format.
054e4681667c planemo upload
lecorguille
parents:
diff changeset
399
054e4681667c planemo upload
lecorguille
parents:
diff changeset
400 xset.BPCs_raw.pdf
054e4681667c planemo upload
lecorguille
parents:
diff changeset
401
054e4681667c planemo upload
lecorguille
parents:
diff changeset
402 | "Base Peak Chromatograms" graph in pdf format with each class samples opposed.
054e4681667c planemo upload
lecorguille
parents:
diff changeset
403
054e4681667c planemo upload
lecorguille
parents:
diff changeset
404 sampleMetadata.tsv
054e4681667c planemo upload
lecorguille
parents:
diff changeset
405
054e4681667c planemo upload
lecorguille
parents:
diff changeset
406 | Tabular file that contains for each sample, it's associated class and polarity (positive,negative and mixed).
054e4681667c planemo upload
lecorguille
parents:
diff changeset
407 | This file is necessary in the Anova and PCA step of the workflow.
054e4681667c planemo upload
lecorguille
parents:
diff changeset
408
054e4681667c planemo upload
lecorguille
parents:
diff changeset
409 xset.RData: rdata.xcms.raw format
054e4681667c planemo upload
lecorguille
parents:
diff changeset
410
054e4681667c planemo upload
lecorguille
parents:
diff changeset
411 | Rdata file that is necessary in the second step of the workflow "xcms.group".
054e4681667c planemo upload
lecorguille
parents:
diff changeset
412
054e4681667c planemo upload
lecorguille
parents:
diff changeset
413 ------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
414
054e4681667c planemo upload
lecorguille
parents:
diff changeset
415 .. class:: infomark
054e4681667c planemo upload
lecorguille
parents:
diff changeset
416
054e4681667c planemo upload
lecorguille
parents:
diff changeset
417 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
418
054e4681667c planemo upload
lecorguille
parents:
diff changeset
419 ---------------------------------------------------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
420
054e4681667c planemo upload
lecorguille
parents:
diff changeset
421 ---------------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
422 Working example
054e4681667c planemo upload
lecorguille
parents:
diff changeset
423 ---------------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
424
054e4681667c planemo upload
lecorguille
parents:
diff changeset
425 Input files
054e4681667c planemo upload
lecorguille
parents:
diff changeset
426 -----------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
427
054e4681667c planemo upload
lecorguille
parents:
diff changeset
428 | zip_file -> **sacuri.zip**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
429
054e4681667c planemo upload
lecorguille
parents:
diff changeset
430 Parameters
054e4681667c planemo upload
lecorguille
parents:
diff changeset
431 ----------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
432
054e4681667c planemo upload
lecorguille
parents:
diff changeset
433 | Method -> **matchedFilter**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
434 | step -> **0.01**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
435 | fwhm -> **4**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
436 | Advanced option -> **show**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
437 | max: -> **50**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
438 | snthresh -> **1**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
439 | steps -> **2**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
440
054e4681667c planemo upload
lecorguille
parents:
diff changeset
441
054e4681667c planemo upload
lecorguille
parents:
diff changeset
442 Output files
054e4681667c planemo upload
lecorguille
parents:
diff changeset
443 ------------
054e4681667c planemo upload
lecorguille
parents:
diff changeset
444
054e4681667c planemo upload
lecorguille
parents:
diff changeset
445 | **1) xset.RData: RData file**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
446
054e4681667c planemo upload
lecorguille
parents:
diff changeset
447 | **2) Example of a sampleMetadata.tsv :**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
448
054e4681667c planemo upload
lecorguille
parents:
diff changeset
449
054e4681667c planemo upload
lecorguille
parents:
diff changeset
450 +---------------------------+------------+---------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
451 | sampleMetadata | class | polarity|
054e4681667c planemo upload
lecorguille
parents:
diff changeset
452 +===========================+============+=========+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
453 |HU_neg_017 | bio |negative |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
454 +---------------------------+------------+---------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
455 |HU_neg_028 | bio |negative |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
456 +---------------------------+------------+---------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
457 |HU_neg_034 | bio |negative |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
458 +---------------------------+------------+---------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
459 |Blanc04 | blank |negative |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
460 +---------------------------+------------+---------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
461 |Blanc06 | blank |negative |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
462 +---------------------------+------------+---------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
463 |Blanc09 | blank |negative |
054e4681667c planemo upload
lecorguille
parents:
diff changeset
464 +---------------------------+------------+---------+
054e4681667c planemo upload
lecorguille
parents:
diff changeset
465
054e4681667c planemo upload
lecorguille
parents:
diff changeset
466
054e4681667c planemo upload
lecorguille
parents:
diff changeset
467
054e4681667c planemo upload
lecorguille
parents:
diff changeset
468 | **3) Example of xset.TICs_raw.pdf (Total Ion Chromatograms) :**
054e4681667c planemo upload
lecorguille
parents:
diff changeset
469
054e4681667c planemo upload
lecorguille
parents:
diff changeset
470 .. image:: xcms_tics.png
054e4681667c planemo upload
lecorguille
parents:
diff changeset
471
054e4681667c planemo upload
lecorguille
parents:
diff changeset
472
5
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
473 ---------------------------------------------------
4
c5fa73f1703f Uploaded
mmonsoor
parents: 0
diff changeset
474
5
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
475 Changelog/News
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
476 --------------
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
477
6
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
478 **Version 2.0.8 - 06/04/2016**
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
479
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
480 - TEST: refactoring to pass planemo test using conda dependencies
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
481
5
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
482
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
483 **Version 2.0.7 - 10/02/2016**
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
484
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
485 - BUGFIX: better management of errors. Datasets remained green although the process failed
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
486
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
487 - BUGFIX/IMPROVEMENT: New checking steps around the imported data in order to raise explicte error message before or after launch XCMS: checking of bad characters in the filenames, checking of the XML integrity and checking of duplicates which can appear in the sample names during the XCMS process because of bad characters
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
488
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
489 - BUGFIX/IMPROVEMENT: New step to check and delete bad characters in the XML: accented characters in the storage path of the mass spectrometer
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
490
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
491 - UPDATE: refactoring of internal management of inputs/outputs
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
492
6
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
493 - TEST: refactoring to feed the new report tool
5
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
494
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
495
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
496 **Version 2.0.2 - 18/01/2016
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
497
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
498 - BUGFIX: Some zip files were tag as "corrupt" by R. We have changed the extraction mode to deal with thoses cases.
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
499
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
500
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
501 **Version 2.0.2 - 09/10/2015**
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
502
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
503 - BUGFIX: Some users reported a bug in xcms.xcmsSet. The preprocessing stops itself and doesn't import the whole dataset contained in the zip file without warning. But meanwhile, please check your samplemetadata dataset and the number of rows.
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
504
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
505
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
506 **Version 2.0.2 - 02/06/2015**
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
507
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
508 - NEW: The W4M workflows will now take as input a zip file to ease the transfer and to improve dataset exchange between tools and users. (See How_to_upload). The previous "Library directory name" is still available but we invite user to switch on the new zip system as soon as possible.
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
509
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
510 - IMPROVEMENT: new datatype/dataset formats (rdata.xcms.raw, rdata.xcms.group, rdata.xcms.retcor ...) will facilitate the sequence of tools and so avoid incompatibility errors.
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
511
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
512 - IMPROVEMENT: parameter labels have changed to facilitate their reading.
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
513
588b0a7ae4b0 planemo upload
lecorguille
parents: 4
diff changeset
514 ]]></help>
0
054e4681667c planemo upload
lecorguille
parents:
diff changeset
515
6
0888f7ef739a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 5
diff changeset
516 <expand macro="citation" />
0
054e4681667c planemo upload
lecorguille
parents:
diff changeset
517 </tool>