annotate ipo4xcmsSet.xml @ 3:9f1e18bc8ce3 draft

planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
author lecorguille
date Thu, 28 Jul 2016 11:03:04 -0400
parents
children 9fa5856f6184
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
1 <tool id="ipo4xcmsSet" name="IPO for xcmsSet" version="2.0.8">
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
2
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
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>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
4
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
5 <macros>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
6 <import>macros.xml</import>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
7 </macros>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
8
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
9 <expand macro="requirements"/>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
10 <expand macro="stdio"/>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
11
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
12 <command><![CDATA[
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
13 @COMMAND_SCRIPT@
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
14
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
15 #if $inputs.input == "zip_file":
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
16 zipfile $inputs.zip_file
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
17 #elif $inputs.input == "single_file":
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
18 singlefile_galaxyPath $inputs.single_file singlefile_sampleName $inputs.single_file.name
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
19 #end if
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
20
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
21 parametersOutput $parametersOutput
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
22
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
23 samplebyclass $samplebyclass
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
24
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
25 ## profmethod $profmethod
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
26 nSlaves \${GALAXY_SLOTS:-1} method $methods.method
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
27 #if $methods.method == "centWave":
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
28 ppm $methods.ppm
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
29 min_peakwidth "c($methods.min_peakwidth)"
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
30 max_peakwidth "c($methods.max_peakwidth)"
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
31 #elif $methods.method == "matchedFilter":
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
32 step $methods.step
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
33 fwhm $methods.fwhm
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
34 #end if
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
35
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
36 @COMMAND_LOG_EXIT@ 2> /tmp/log.err
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
37 ]]></command>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
38
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
39 <inputs>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
40
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
41 <conditional name="inputs">
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
42 <param name="input" type="select" label="Choose your inputs method" >
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
43 <option value="zip_file" selected="true">Zip file from your history containing your chromatograms</option>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
44 <option value="single_file">mzXML file from your history</option>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
45 </param>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
46 <when value="zip_file">
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
47 <param name="zip_file" type="data" format="no_unzip.zip,zip" label="Zip file" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
48 </when>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
49 <when value="single_file">
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
50 <param name="single_file" type="data" format="mzxml" label="Single file" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
51 </when>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
52 </conditional>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
53
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
54 <param name="samplebyclass" type="integer" value="2" label="Number of samples used per class to estimate the best parameters" help="Set to 0 to use the whole dataset. To save time, reduce this number" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
55
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
56 <conditional name="methods">
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
57 <param name="method" type="select" label="Extraction method for peaks detection" help="[method] See the help section below">
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
58 <option value="centWave" >centWave</option>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
59 <option value="matchedFilter" selected="true">matchedFilter</option>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
60 </param>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
61
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
62 <!-- centWave Filter options -->
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
63 <when value="centWave">
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
64 <param name="ppm" type="text" value="5,25" label="Max tolerated ppm m/z deviation in consecutive scans in ppm" help="[ppm]" optional="false" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
65 <param name="min_peakwidth" type="text" value="15,25" label="Min peak width range in seconds" help="[peakwidth]" optional="true" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
66 <param name="max_peakwidth" type="text" value="45,55" label="Max peak width range in seconds" help="[peakwidth]" optional="true" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
67 </when>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
68
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
69 <!-- matched Filter options -->
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
70 <when value="matchedFilter">
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
71 <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" optional="true" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
72 <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" optional="true" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
73 </when>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
74 </conditional>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
75
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
76
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
77 </inputs>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
78
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
79 <outputs>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
80 <data name="parametersOutput" format="tabular" label="IPO_parameters4xcmsSet.tsv" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
81 <data name="log" format="txt" label="ipo4xcmsSet.log.txt" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
82 </outputs>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
83
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
84 <tests>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
85 <test>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
86 <param name="inputs|input" value="single_file" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
87 <param name="inputs|single_file" value="MM14.mzML" ftype="mzxml" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
88 <param name="methods|method" value="centWave" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
89 <param name="methods|ppm" value="56" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
90 <param name="methods|min_peakwidth" value="3,9.5" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
91 <param name="methods|max_peakwidth" value="10,20" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
92 <output name="parametersOutput" file="MM14_IPO_parameters4xcmsSet.tsv" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
93 </test>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
94 <!--Failed:
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
95 Error in resultIncreased(history) :
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
96 No isotopes have been detected, peak picking not optimizable by IPO!-->
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
97 <!--<test>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
98 <param name="inputs|input" value="zip_file" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
99 <param name="inputs|zip_file" value="sacuri_2files.zip" ftype="zip" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
100 <param name="samplebyclass" value="1" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
101 <param name="methods|method" value="centWave" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
102 <param name="methods|ppm" value="25" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
103 <param name="methods|min_peakwidth" value="20,30" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
104 <param name="methods|max_peakwidth" value="45,55" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
105 <output name="parametersOutput" file="sacuri_2files_centWave_IPO_parameters4xcmsSet.tsv" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
106 </test>-->
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
107 <!-- Too long for Travis CI -->
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
108 <!--<test>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
109 <param name="inputs|input" value="zip_file" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
110 <param name="inputs|zip_file" value="sacuri_2files.zip" ftype="zip" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
111 <param name="samplebyclass" value="1" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
112 <param name="methods|method" value="matchedFilter" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
113 <param name="methods|step" value="0.01" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
114 <param name="methods|fwhm" value="4" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
115 <output name="parametersOutput" file="sacuri_2files_matchedFilter_IPO_parameters4xcmsSet.tsv" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
116 </test>-->
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
117 </tests>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
118
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
119 <help><![CDATA[
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
120
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
121 @HELP_AUTHORS@
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
122
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
123 ===============
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
124 IPO.ipo4xcmsSet
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
125 ===============
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
126
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
127 -----------
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
128 Description
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
129 -----------
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
130
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
131 A Tool for automated Optimization of XCMS Parameters
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
132
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
133
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
134 -----------------
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
135 Workflow position
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
136 -----------------
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
137
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
138 **Upstream tools**
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
139
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
140 ========================= ================= ======= =========
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
141 Name output file format parameter
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
142 ========================= ================= ======= =========
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
143 NA NA zip NA
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
144 ========================= ================= ======= =========
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
145
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
146
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
147 **Downstream tools**
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
148
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
149 +---------------------------+----------------------+-----------------+
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
150 | Name | Output file | Format |
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
151 +===========================+======================+=================+
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
152 |xcms.xcmsSet | parametersOutput.tsv | Tabular |
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
153 +---------------------------+--------------------+-------------------+
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
154
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
155
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
156
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
157 -----------
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
158 Input files
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
159 -----------
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
160
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
161 +---------------------------+------------+
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
162 | Parameter : num + label | Format |
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
163 +===========================+============+
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
164 | 1 : Choose your inputs | zip |
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
165 +---------------------------+------------+
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
166
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
167 **Choose your inputs**
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
168
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
169 You have two methods for your inputs:
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
170
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
171 | Zip file (recommended): You can put a zip file containing your inputs: myinputs.zip (containing all your conditions as sub-directories).
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
172 | 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.
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
173
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
174 Steps for creating the zip file
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
175 -------------------------------
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
176
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
177 **Step1: Creating your directory and hierarchize the subdirectories**
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
178
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
179
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
180 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).
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
181
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
182 Your zip should contain all your conditions as sub-directories. For example, two conditions (mutant and wild):
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
183 arabidopsis/wild/01.raw
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
184 arabidopsis/mutant/01.raw
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
185
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
186 **Step2: Creating a zip file**
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
187
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
188 Create your zip file (e.g.: arabidopsis.zip).
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
189
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
190 **Step 3 : Uploading it to our Galaxy server**
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
191
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
192 If your zip file is less than 2Gb, you get use the Get Data tool to upload it.
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
193
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
194 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).
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
195
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
196 For more informations, don't hesitate to send us an email at supportATworkflow4metabolomics.org).
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
197
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
198 Advices for converting your files for the XCMS input
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
199 ----------------------------------------------------
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
200
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
201 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.
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
202
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
203 **We recommend you the following parameters:**
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
204
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
205 Use Filtering: **True**
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
206
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
207 Use Peak Picking: **True**
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
208
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
209 Peak Peaking -Apply to MS Levels: **All Levels (1-)** : Centroid Mode
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
210
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
211 Use zlib: **64**
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
212
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
213 Binary Encoding: **64**
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
214
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
215 m/z Encoding: **64**
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
216
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
217 Intensity Encoding: **64**
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
218
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
219
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
220 ----------
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
221 Parameters
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
222 ----------
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
223
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
224 Extraction method for peaks detection
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
225 -------------------------------------
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
226
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
227 **Matched Filter**
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
228
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
229 | One parameter to consider is the Gaussian model peak width used for matched filtration,an integral part of the peak detection algorithm.
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
230 | For a discussion of how model peak width affects the signal to noise ratio, see Danielsson et al. (2002).
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
231
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
232
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
233 **cent Wave**
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
234
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
235 | This algorithm is most suitable for high resolution LC/{TOF,OrbiTrap,FTICR}-MS data in centroid mode.
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
236 | Due to the fact that peak centroids are used, a binning step is not necessary.
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
237 | 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.
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
238
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
239
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
240 ------------
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
241 Output files
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
242 ------------
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
243
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
244 IPO_parameters4xcmsSet.tsv
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
245
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
246 | Optimal parameters for xcmsSet
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
247
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
248
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
249 ---------------------------------------------------
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
250
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
251 Changelog/News
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
252 --------------
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
253
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
254
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
255
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
256 ]]></help>
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
257
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
258 <expand macro="citation" />
9f1e18bc8ce3 planemo upload commit ceb25d29a013b58d3476323f202276e7c876648a-dirty
lecorguille
parents:
diff changeset
259 </tool>