Mercurial > repos > lecorguille > xcms_xcmsset
comparison abims_xcms_xcmsSet.xml @ 29:5dba1c94fb94 draft
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit bff1445c9b00ccdbe05ee3dc6ed24221033384b9
author | lecorguille |
---|---|
date | Tue, 24 Oct 2017 11:46:21 -0400 |
parents | b90e4f92e8b5 |
children | d71827ecd22c |
comparison
equal
deleted
inserted
replaced
28:b90e4f92e8b5 | 29:5dba1c94fb94 |
---|---|
1 <tool id="abims_xcms_xcmsSet" name="xcms.xcmsSet" version="2.1.0"> | 1 <tool id="abims_xcms_xcmsSet" name="xcms.xcmsSet" version="2.2.0"> |
2 <description>Filtration and Peak Identification using xcmsSet function from xcms R package to preprocess LC/MS data for relative quantification and statistical analysis </description> | 2 <description>Filtration and Peak Identification using xcmsSet function from xcms R package to preprocess LC/MS data for relative quantification and statistical analysis </description> |
3 | 3 |
4 <macros> | 4 <macros> |
5 <import>macros.xml</import> | 5 <import>macros.xml</import> |
6 </macros> | 6 </macros> |
19 | 19 |
20 xfunction xcmsSet | 20 xfunction xcmsSet |
21 | 21 |
22 xsetRdataOutput '$xsetRData' | 22 xsetRdataOutput '$xsetRData' |
23 sampleMetadataOutput '$sampleMetadata' | 23 sampleMetadataOutput '$sampleMetadata' |
24 ticspdf '$ticsRawPdf' | |
25 bicspdf '$bpcsRawPdf' | |
26 | |
27 | 24 |
28 #if $options_scanrange.option == "show": | 25 #if $options_scanrange.option == "show": |
29 scanrange "c($options_scanrange.scanrange)" | 26 scanrange "c($options_scanrange.scanrange)" |
30 #end if | 27 #end if |
31 | 28 |
57 winSize.noise $methods.winSize_noise | 54 winSize.noise $methods.winSize_noise |
58 amp.Th $methods.amp_Th | 55 amp.Th $methods.amp_Th |
59 scales "c($methods.scales)" | 56 scales "c($methods.scales)" |
60 SNR.method "$methods.SNR_method" | 57 SNR.method "$methods.SNR_method" |
61 #end if | 58 #end if |
62 @COMMAND_LOG_EXIT@ | 59 |
60 #if $input.is_of_type("mzxml") or $input.is_of_type("mzml") or $input.is_of_type("mzdata") or $input.is_of_type("netcdf"): | |
61 && mv *-TIC_mqc.out $ticsRawTab | |
62 && mv *-BPC_mqc.out $bpcsRawTab | |
63 #end if | |
64 | |
65 @COMMAND_LOG_EXIT@; | |
63 ]]></command> | 66 ]]></command> |
64 | 67 |
65 <inputs> | 68 <inputs> |
66 | 69 |
67 <param name="input" type="data" format="mzxml,mzml,mzdata,netcdf,no_unzip.zip,zip" label="File(s) from your history containing your chromatograms" help="Single file mode for the format: mzxml, mzml, mzdata and netcdf. Zip file mode for the format: no_unzip.zip, zip. See the help section below." /> | 70 <param name="input" type="data" format="mzxml,mzml,mzdata,netcdf,no_unzip.zip,zip" label="File(s) from your history containing your chromatograms" help="Single file mode for the format: mzxml, mzml, mzdata and netcdf. Zip file mode for the format: no_unzip.zip, zip. See the help section below." /> |
153 <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" /> | 156 <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" /> |
154 <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 " /> | 157 <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 " /> |
155 <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." /> | 158 <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." /> |
156 </when> | 159 </when> |
157 </conditional> | 160 </conditional> |
161 | |
162 | |
163 <expand macro="input_tic_bpc_pdf"/> | |
158 </inputs> | 164 </inputs> |
159 | 165 |
160 <outputs> | 166 <outputs> |
161 <data name="xsetRData" format="rdata.xcms.raw" label="${input.name.rsplit('.',1)[0]}.xset.RData" /> | 167 <data name="xsetRData" format="rdata.xcms.raw" label="${input.name.rsplit('.',1)[0]}.xset.RData" /> |
168 <data name="log" format="txt" label="${input.name.rsplit('.',1)[0]}.xset.log.txt" /> | |
169 | |
170 <!-- SINGLE MODE --> | |
171 <data name="ticsRawTab" format="tabular" label="${input.name.rsplit('.',1)[0]}.xset.TICs_raw.tabular"> | |
172 <filter>input.extension in ["mzxml","mzml","mzdata","netcdf"]</filter> | |
173 </data> | |
174 <data name="bpcsRawTab" format="tabular" label="${input.name.rsplit('.',1)[0]}.xset.BPCs_raw.tabular"> | |
175 <filter>input.extension in ["mzxml","mzml","mzdata","netcdf"]</filter> | |
176 </data> | |
177 | |
178 <!-- ZIP MODE --> | |
162 <data name="sampleMetadata" format="tabular" label="${input.name.rsplit('.',1)[0]}.sampleMetadata.tsv"> | 179 <data name="sampleMetadata" format="tabular" label="${input.name.rsplit('.',1)[0]}.sampleMetadata.tsv"> |
163 <filter>input.extension not in ["mzxml","mzml","mzdata","netcdf"]</filter> | 180 <filter>input.extension not in ["mzxml","mzml","mzdata","netcdf"]</filter> |
164 </data> | 181 </data> |
165 <data name="ticsRawPdf" format="pdf" label="${input.name.rsplit('.',1)[0]}.xset.TICs_raw.pdf" /> | 182 <data name="ticsRawPdf" format="pdf" from_work_dir="TICs.pdf" label="${input.name.rsplit('.',1)[0]}.xset.TICs_raw.pdf"> |
166 <data name="bpcsRawPdf" format="pdf" label="${input.name.rsplit('.',1)[0]}.xset.BPCs_raw.pdf" /> | 183 <filter>input.extension not in ["mzxml","mzml","mzdata","netcdf"]</filter> |
167 <data name="log" format="txt" label="${input.name.rsplit('.',1)[0]}.xset.log.txt" /> | 184 <filter>tic_bpc_pdf</filter> |
185 </data> | |
186 <data name="bpcsRawPdf" format="pdf" from_work_dir="BPCs.pdf" label="${input.name.rsplit('.',1)[0]}.xset.BPCs_raw.pdf"> | |
187 <filter>input.extension not in ["mzxml","mzml","mzdata","netcdf"]</filter> | |
188 <filter>tic_bpc_pdf</filter> | |
189 </data> | |
190 <collection name="ticsRawTabCollection" type="list" label="TIC raw tabular"> | |
191 <filter>input.extension not in ["mzxml","mzml","mzdata","netcdf"]</filter> | |
192 <discover_datasets pattern="(?P<designation>.+)-TIC_mqc\.out" ext="tabular" visible="true" /> | |
193 </collection> | |
194 <collection name="bpcsRawTabCollection" type="list" label="BPC raw tabular"> | |
195 <filter>input.extension not in ["mzxml","mzml","mzdata","netcdf"]</filter> | |
196 <discover_datasets pattern="(?P<designation>.+)-BPC_mqc\.out" ext="tabular" visible="true" /> | |
197 </collection> | |
168 </outputs> | 198 </outputs> |
169 | 199 |
170 <tests> | 200 <tests> |
171 <!--<test> | 201 <!-- |
172 <param name="input" value="sacuri_dir_root.zip" ftype="zip" /> | |
173 <param name="methods|method" value="matchedFilter" /> | |
174 <param name="methods|step" value="0.01" /> | |
175 <param name="methods|fwhm" value="4" /> | |
176 <param name="methods|options_m|option" value="show" /> | |
177 <param name="methods|options_m|max" value="50" /> | |
178 <param name="methods|options_m|snthresh" value="1" /> | |
179 <param name="methods|options_m|steps" value="2" /> | |
180 <output name="log"> | |
181 <assert_contents> | |
182 <has_text text="object with 4 samples" /> | |
183 <has_text text="Time range: 0.7-1139.7 seconds (0-19 minutes)" /> | |
184 <has_text text="Mass range: 50.0021-999.9863 m/z" /> | |
185 <has_text text="Peaks: 59359 (about 14840 per sample)" /> | |
186 <has_text text="Peak Groups: 0" /> | |
187 <has_text text="Sample classes: bio, blank" /> | |
188 </assert_contents> | |
189 </output> | |
190 </test> | |
191 <test> | 202 <test> |
192 <param name="input" value="sacuri_current_root.zip" ftype="zip" /> | 203 <param name="input" value="sacuri_current_root.zip" ftype="zip" /> |
193 <param name="methods|method" value="centWave" /> | 204 <param name="methods|method" value="centWave" /> |
194 <param name="methods|ppm" value="25" /> | 205 <param name="methods|ppm" value="25" /> |
195 <param name="methods|peakwidth" value="20,50" /> | 206 <param name="methods|peakwidth" value="20,50" /> |
217 <has_text text="Peaks: 9251 (about 2313 per sample)" /> | 228 <has_text text="Peaks: 9251 (about 2313 per sample)" /> |
218 <has_text text="Peak Groups: 0" /> | 229 <has_text text="Peak Groups: 0" /> |
219 <has_text text="Sample classes: KO, WT" /> | 230 <has_text text="Sample classes: KO, WT" /> |
220 </assert_contents> | 231 </assert_contents> |
221 </output> | 232 </output> |
233 <output_collection name="ticsRawTabCollection" type="list"> | |
234 <element name="ko15" value="ko15-TIC_mqc.out" /> | |
235 <element name="ko16" value="ko16-TIC_mqc.out" /> | |
236 <element name="wt15" value="wt15-TIC_mqc.out" /> | |
237 <element name="wt16" value="wt16-TIC_mqc.out" /> | |
238 </output_collection> | |
239 <output_collection name="bpcsRawTabCollection" type="list"> | |
240 <element name="ko15" value="ko15-BPC_mqc.out" /> | |
241 <element name="ko16" value="ko16-BPC_mqc.out" /> | |
242 <element name="wt15" value="wt15-BPC_mqc.out" /> | |
243 <element name="wt16" value="wt16-BPC_mqc.out" /> | |
244 </output_collection> | |
222 </test> | 245 </test> |
223 <!-- Passed but disable to save time for Travis" --> | 246 <!-- Passed but disable to save time for Travis" --> |
224 <!--<test> | 247 <!-- |
225 <param name="input" value="ko15.CDF" ftype="netcdf" /> | |
226 <param name="methods|method" value="centWave" /> | |
227 <param name="methods|ppm" value="25" /> | |
228 <param name="methods|peakwidth" value="20,50" /> | |
229 <output name="log"> | |
230 <assert_contents> | |
231 <has_text text="object with 1 samples" /> | |
232 <has_text text="Time range: 2506.1-4471.7 seconds (41.8-74.5 minutes)" /> | |
233 <has_text text="Mass range: 200.2-600 m/z" /> | |
234 <has_text text="Peaks: 2262 (about 2262 per sample)" /> | |
235 <has_text text="Peak Groups: 0" /> | |
236 <has_text text="Sample classes: ." /> | |
237 </assert_contents> | |
238 </output> | |
239 </test> | |
240 <test> | |
241 <param name="input" value="ko16.CDF" ftype="netcdf" /> | |
242 <param name="methods|method" value="centWave" /> | |
243 <param name="methods|ppm" value="25" /> | |
244 <param name="methods|peakwidth" value="20,50" /> | |
245 <output name="log"> | |
246 <assert_contents> | |
247 <has_text text="object with 1 samples" /> | |
248 <has_text text="Time range: 2521.7-4477.9 seconds (42-74.6 minutes)" /> | |
249 <has_text text="Mass range: 200.1-600 m/z" /> | |
250 <has_text text="Peaks: 2408 (about 2408 per sample)" /> | |
251 <has_text text="Peak Groups: 0" /> | |
252 <has_text text="Sample classes: ." /> | |
253 </assert_contents> | |
254 </output> | |
255 </test> | |
256 <test> | |
257 <param name="input" value="wt15.CDF" ftype="netcdf" /> | |
258 <param name="methods|method" value="centWave" /> | |
259 <param name="methods|ppm" value="25" /> | |
260 <param name="methods|peakwidth" value="20,50" /> | |
261 <output name="log"> | |
262 <assert_contents> | |
263 <has_text text="object with 1 samples" /> | |
264 <has_text text="Time range: 2517-4473.2 seconds (42-74.6 minutes)" /> | |
265 <has_text text="Mass range: 200.2-599.8 m/z" /> | |
266 <has_text text="Peaks: 2278 (about 2278 per sample)" /> | |
267 <has_text text="Peak Groups: 0" /> | |
268 <has_text text="Sample classes: ." /> | |
269 </assert_contents> | |
270 </output> | |
271 </test> | |
272 <test> | 248 <test> |
273 <param name="inputs|input" value="single_file" /> | 249 <param name="inputs|input" value="single_file" /> |
274 <param name="inputs|single_file" value="wt16.CDF" ftype="netcdf" /> | 250 <param name="inputs|single_file" value="wt16.CDF" ftype="netcdf" /> |
275 <param name="methods|method" value="centWave" /> | 251 <param name="methods|method" value="centWave" /> |
276 <param name="methods|ppm" value="25" /> | 252 <param name="methods|ppm" value="25" /> |
299 <has_text text="Peaks: 380 (about 380 per sample)" /> | 275 <has_text text="Peaks: 380 (about 380 per sample)" /> |
300 <has_text text="Peak Groups: 0" /> | 276 <has_text text="Peak Groups: 0" /> |
301 <has_text text="Sample classes: ." /> | 277 <has_text text="Sample classes: ." /> |
302 </assert_contents> | 278 </assert_contents> |
303 </output> | 279 </output> |
280 <output name="ticsRawTab" value="HU_neg_017-TIC_mqc.out" /> | |
281 <output name="bpcsRawTab" value="HU_neg_017-BPC_mqc.out" /> | |
304 </test> | 282 </test> |
305 <test> | 283 <test> |
306 <param name="input" value="MM14.mzML" ftype="mzxml" /> | 284 <param name="input" value="MM14.mzML" ftype="mzxml" /> |
307 <param name="methods|method" value="centWave" /> | 285 <param name="methods|method" value="centWave" /> |
308 <param name="methods|ppm" value="56" /> | 286 <param name="methods|ppm" value="56" /> |
315 <has_text text="Peaks: 222 (about 222 per sample)" /> | 293 <has_text text="Peaks: 222 (about 222 per sample)" /> |
316 <has_text text="Peak Groups: 0" /> | 294 <has_text text="Peak Groups: 0" /> |
317 <has_text text="Sample classes: ." /> | 295 <has_text text="Sample classes: ." /> |
318 </assert_contents> | 296 </assert_contents> |
319 </output> | 297 </output> |
298 <output name="ticsRawTab" value="MM14-TIC_mqc.out" /> | |
299 <output name="bpcsRawTab" value="MM14-BPC_mqc.out" /> | |
320 </test> | 300 </test> |
321 </tests> | 301 </tests> |
322 | 302 |
323 <help><![CDATA[ | 303 <help><![CDATA[ |
324 | 304 |
326 | 306 |
327 ============ | 307 ============ |
328 Xcms.xcmsSet | 308 Xcms.xcmsSet |
329 ============ | 309 ============ |
330 | 310 |
331 ----------- | |
332 Description | 311 Description |
333 ----------- | 312 ----------- |
334 | 313 |
335 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. | 314 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. |
336 You can read a tutorial on how to perform xcms preprocessing which is available here_. | 315 You can read a tutorial on how to perform xcms preprocessing which is available here_. |
337 | 316 |
338 .. _here: http://web11.sb-roscoff.fr/download/w4m/howto/w4m_HowToPerformXcmsPreprocessing_v02.pdf | 317 .. _here: http://web11.sb-roscoff.fr/download/w4m/howto/w4m_HowToPerformXcmsPreprocessing_v02.pdf |
339 | 318 |
340 | 319 |
341 ----------------- | |
342 Workflow position | 320 Workflow position |
343 ----------------- | 321 ----------------- |
344 | 322 |
345 **Upstream tools** | 323 **Upstream tools** |
346 | 324 |
347 ========================= ================= ======= ========= | 325 +------------------------+--------------------+-----------------------------+-----------+ |
348 Name output file format parameter | 326 | Name | output file | format | parameter | |
349 ========================= ================= ======= ========= | 327 +------------------------+--------------------+-----------------------------+-----------+ |
350 NA NA zip NA | 328 | Upload File | Dataset Collection | mzXML, mzML, mzData, netCDF | NA | |
351 ========================= ================= ======= ========= | 329 +------------------------+--------------------+-----------------------------+-----------+ |
352 | |
353 | 330 |
354 **Downstream tools** | 331 **Downstream tools** |
355 | 332 |
356 +---------------------------+--------------------+-----------------+ | 333 +---------------------------+--------------------+-----------------+ |
357 | Name | Output file | Format | | 334 | Name | Output file | Format | |
358 +===========================+====================+=================+ | 335 +===========================+====================+=================+ |
359 |xcms.group | xset.RData | rdata.xcms.raw | | 336 |xcms.group | xset.RData | rdata.xcms.raw | |
360 +---------------------------+--------------------+-----------------+ | 337 +---------------------------+--------------------+-----------------+ |
361 |PCA ellipsoid by factors | sampleMetadata.tsv | Tabular | | |
362 +---------------------------+--------------------+-----------------+ | |
363 |Anova | sampleMetadata.tsv | Tabular | | |
364 +---------------------------+--------------------+-----------------+ | |
365 | 338 |
366 | 339 |
367 **Example of a metabolomic workflow** | 340 **Example of a metabolomic workflow** |
368 | 341 |
369 .. image:: xcms_xcmsset_workflow.png | 342 .. image:: xcms_xcmsset_workflow.png |
370 | 343 |
371 | |
372 ------ | |
373 | |
374 .. class:: infomark | |
375 | |
376 The output file is an xset.RData file. You can continue your analysis using it in **xcms.group** tool. | |
377 | |
378 --------------------------------------------------- | 344 --------------------------------------------------- |
379 | |
380 | |
381 | 345 |
382 ----------- | 346 ----------- |
383 Input files | 347 Input files |
384 ----------- | 348 ----------- |
385 | 349 |
350 Choose your inputs | |
351 ------------------ | |
352 | |
386 +---------------------------+----------------------------------+ | 353 +---------------------------+----------------------------------+ |
387 | Parameter : num + label | Format | | 354 | Parameter | Format | |
388 +===========================+==================================+ | 355 +===========================+==================================+ |
356 | OR : Single file | mzXML, mzML, mzData, netCDF | | |
357 +---------------------------+----------------------------------+ | |
389 | OR : Zip file | zip | | 358 | OR : Zip file | zip | |
390 +---------------------------+----------------------------------+ | 359 +---------------------------+----------------------------------+ |
391 | OR : Single file | mzXML, mzML, mzData, netCDF | | |
392 +---------------------------+----------------------------------+ | |
393 | |
394 **Choose your inputs** | |
395 | 360 |
396 You have two methods for your inputs: | 361 You have two methods for your inputs: |
397 | 362 |
398 | Single file (recommended): You can put a single file as input. That way, you will be able to launch several xcmsSet in parallel and use "xcms.xcmsSet Merger" before "xcms.group" | 363 * Single file (recommended): You can put a single file as input. That way, you will be able to launch several xcmsSet in parallel and use "xcms.xcmsSet Merger" before "xcms.group" |
399 | Zip file: You can put a zip file containing your inputs: myinputs.zip (containing all your conditions as sub-directories). | 364 |
400 | 365 * Zip file: You can put a zip file containing your inputs: myinputs.zip (containing all your conditions as sub-directories). |
401 Zip file: Steps for creating the zip file | 366 |
402 ----------------------------------------- | 367 Single file |
368 ----------- | |
369 | |
370 This method is recommended because: | |
371 | |
372 * Since files are uploaded indivudially, they are smaller. And so they should be able to be uploaded using the Get Data tools. | |
373 | |
374 * It allow you to launch your xcmsSet in parallele. | |
375 | |
376 You just have to create a Dataset Collection as explain in this video_ | |
377 | |
378 .. _video: http://download.workflow4metabolomics.org/docs/170510_galaxy_xcms_dataset_collection.m4v | |
379 | |
380 | |
381 Zip file | |
382 -------- | |
383 | |
384 This method isn't recommended because zip file aren't really well integrated | |
385 | |
386 Steps for creating the zip file | |
403 | 387 |
404 **Step1: Creating your directory and hierarchize the subdirectories** | 388 **Step1: Creating your directory and hierarchize the subdirectories** |
405 | 389 |
406 | 390 |
407 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). | 391 | **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). |
408 | 392 | Your zip should contain all your conditions as sub-directories. For example, two conditions (mutant and wild): |
409 Your zip should contain all your conditions as sub-directories. For example, two conditions (mutant and wild): | 393 | - arabidopsis/wild/01.raw |
410 arabidopsis/wild/01.raw | 394 | - arabidopsis/mutant/01.raw |
411 arabidopsis/mutant/01.raw | |
412 | 395 |
413 **Step2: Creating a zip file** | 396 **Step2: Creating a zip file** |
414 | 397 |
415 Create your zip file (e.g.: arabidopsis.zip). | 398 | Create your zip file (e.g.: arabidopsis.zip). |
416 | 399 |
417 **Step 3 : Uploading it to our Galaxy server** | 400 **Step 3 : Uploading it to our Galaxy server** |
418 | 401 |
419 If your zip file is less than 2Gb, you get use the Get Data tool to upload it. | 402 | If your zip file is less than 2Gb, you get use the Get Data tool to upload it. |
420 | 403 | 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). |
421 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). | 404 | For more informations, don't hesitate to send us an email at supportATworkflow4metabolomics.org). |
422 | 405 | Advices for converting your files for the XCMS input |
423 For more informations, don't hesitate to send us an email at supportATworkflow4metabolomics.org). | 406 |
424 | 407 Raw file format |
425 Advices for converting your files for the XCMS input | 408 --------------- |
426 ---------------------------------------------------- | 409 |
427 | 410 We recommend you to convert your raw files to **mzXML** in centroid mode (smaller files) and the files will be compatible with the xcms centWave method. |
428 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. | |
429 | 411 |
430 **We recommend you the following parameters:** | 412 **We recommend you the following parameters:** |
431 | 413 |
432 Use Filtering: **True** | 414 | **Use Filtering**: True |
433 | 415 | **Use Peak Picking**: True |
434 Use Peak Picking: **True** | 416 | **Peak Peaking**: -Apply to MS Levels: All Levels (1-) : Centroid Mode |
435 | 417 | **Use zlib**: 64 |
436 Peak Peaking -Apply to MS Levels: **All Levels (1-)** : Centroid Mode | 418 | **Binary Encoding**: 64 |
437 | 419 | **m/z Encoding**: 64 |
438 Use zlib: **64** | 420 | **Intensity Encoding**: 64 |
439 | |
440 Binary Encoding: **64** | |
441 | |
442 m/z Encoding: **64** | |
443 | |
444 Intensity Encoding: **64** | |
445 | 421 |
446 | 422 |
447 ---------- | 423 ---------- |
448 Parameters | 424 Parameters |
449 ---------- | 425 ---------- |
473 | 449 |
474 ------------ | 450 ------------ |
475 Output files | 451 Output files |
476 ------------ | 452 ------------ |
477 | 453 |
478 xset.TICs_raw.pdf | 454 xset.RData: rdata.xcms.raw format |
479 | 455 |
480 | "Total Ion Chromatograms" graph in pdf format. | 456 | Rdata file that is necessary in the second step of the workflow "xcms.group". |
481 | 457 |
482 xset.BPCs_raw.pdf | 458 @HELP_BCP_TIC@ |
483 | 459 |
484 | "Base Peak Chromatograms" graph in pdf format with each class samples opposed. | 460 sampleMetadata.tsv [if using zip] |
485 | |
486 sampleMetadata.tsv | |
487 | 461 |
488 | Tabular file that contains for each sample, it's associated class and polarity (positive,negative and mixed). | 462 | Tabular file that contains for each sample, it's associated class and polarity (positive,negative and mixed). |
489 | This file is necessary in the Anova and PCA step of the workflow. | 463 | This file is necessary in the Batch correction and statictics steps of the workflow. |
490 | |
491 xset.RData: rdata.xcms.raw format | |
492 | |
493 | Rdata file that is necessary in the second step of the workflow "xcms.group". | |
494 | |
495 ------ | |
496 | |
497 .. class:: infomark | |
498 | |
499 The output file is an xset.RData file. You can continue your analysis using it in **xcms.group** tool. | |
500 | 464 |
501 --------------------------------------------------- | 465 --------------------------------------------------- |
502 | 466 |
503 --------------- | 467 --------------- |
504 Working example | 468 Working example |
505 --------------- | 469 --------------- |
506 | 470 |
507 Input files | 471 Input files |
508 ----------- | 472 ----------- |
509 | 473 |
510 | zip_file -> **sacuri.zip** | 474 | Dataset Collection -> build using this dataset_ |
475 | |
476 .. _dataset: http://download.workflow4metabolomics.org/datasets/sacurine-neg-subset_mzXML.zip | |
511 | 477 |
512 Parameters | 478 Parameters |
513 ---------- | 479 ---------- |
514 | 480 |
515 | Method -> **matchedFilter** | 481 | **Method**: centWave |
516 | step -> **0.01** | 482 | **Max tolerated ppm m/z deviation in consecutive scans in ppm**: 25 |
517 | fwhm -> **4** | 483 | **Min,Max peak width in seconds**: 10,40 |
518 | Advanced option -> **show** | 484 | **Advanced option**: show |
519 | max: -> **50** | 485 | **Signal/Noise threshold**: 50 |
520 | snthresh -> **1** | 486 | **Minimum difference in m/z for peaks with overlapping retention times**: 1 |
521 | steps -> **2** | 487 | **Prefilter step for the first phase**: 3,100 |
522 | |
523 | |
524 Output files | |
525 ------------ | |
526 | |
527 | **1) xset.RData: RData file** | |
528 | |
529 | **2) Example of a sampleMetadata.tsv :** | |
530 | |
531 | |
532 +---------------------------+------------+---------+ | |
533 | sampleMetadata | class | polarity| | |
534 +===========================+============+=========+ | |
535 |HU_neg_017 | bio |negative | | |
536 +---------------------------+------------+---------+ | |
537 |HU_neg_028 | bio |negative | | |
538 +---------------------------+------------+---------+ | |
539 |HU_neg_034 | bio |negative | | |
540 +---------------------------+------------+---------+ | |
541 |Blanc04 | blank |negative | | |
542 +---------------------------+------------+---------+ | |
543 |Blanc06 | blank |negative | | |
544 +---------------------------+------------+---------+ | |
545 |Blanc09 | blank |negative | | |
546 +---------------------------+------------+---------+ | |
547 | |
548 | |
549 | |
550 | **3) Example of xset.TICs_raw.pdf (Total Ion Chromatograms) :** | |
551 | |
552 .. image:: xcms_tics.png | |
553 | 488 |
554 | 489 |
555 --------------------------------------------------- | 490 --------------------------------------------------- |
556 | 491 |
557 Changelog/News | 492 Changelog/News |
558 -------------- | 493 -------------- |
559 | 494 |
495 **Version 2.2.0 - 19/10/2017** | |
496 | |
497 - NEW: The TIC and BPC is new exported as tabular files to be visualized using MultiQC. | |
498 | |
560 **Version 2.1.0 - 22/02/2017** | 499 **Version 2.1.0 - 22/02/2017** |
561 | 500 |
562 - NEW: The W4M tools will be able now to take as input a single file. It will allow to submit in parallel several files and merge them afterward using "xcms.xcmsSet Merger" before "xcms.group". | 501 - NEW: The W4M tools will be able now to take as input a single file. It will allow to submit in parallel several files and merge them afterward using "xcms.xcmsSet Merger" before "xcms.group". |
563 | 502 |
564 - BUGFIX: the default value of "matchedFilter" -> "Step size to use for profile generation" which was of 0.01 have been changed to fix with the XMCS default values to 0.1 | 503 - BUGFIX: the default value of "matchedFilter" -> "Step size to use for profile generation" which was of 0.01 have been changed to fix with the XMCS default values to 0.1 |
591 - UPDATE: refactoring of internal management of inputs/outputs | 530 - UPDATE: refactoring of internal management of inputs/outputs |
592 | 531 |
593 - TEST: refactoring to feed the new report tool | 532 - TEST: refactoring to feed the new report tool |
594 | 533 |
595 | 534 |
596 **Version 2.0.2 - 18/01/2016 | 535 **Version 2.0.2 - 18/01/2016** |
597 | 536 |
598 - BUGFIX: Some zip files were tag as "corrupt" by R. We have changed the extraction mode to deal with thoses cases. | 537 - BUGFIX: Some zip files were tag as "corrupt" by R. We have changed the extraction mode to deal with thoses cases. |
599 | 538 |
600 | 539 |
601 **Version 2.0.2 - 09/10/2015** | 540 **Version 2.0.2 - 09/10/2015** |