annotate msclust.xml @ 54:10f3cb998c4e

small fix
author pieter.lukasse@wur.nl
date Thu, 11 Dec 2014 14:32:19 +0100
parents f772a5caa86a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
49
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 48
diff changeset
1 <tool name="MsClust" id="msclust2" version="2.0.7">
3
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
2 <description>Extracts fragmentation spectra from aligned data</description>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
3 <!--
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
4 For remote debugging start you listener on port 8000 and use the following as command interpreter:
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
5 java -jar -Xdebug -Xrunjdwp:transport=dt_socket,address=D0100564.wurnet.nl:8000
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
6 //////////////////////////
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
7
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
8 TODO in command below: add conditionals according to options of using or NOT the tolerances/thresholds from previous steps
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
9 -->
35
0ff22eec3e4b added peak_width_max for better performance
pieter.lukasse@wur.nl
parents: 33
diff changeset
10 <command interpreter="java -jar ">
3
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
11 MsClust.jar
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
12 -peaksFileName $inputPeaks
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
13 -dataType $dataType
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
14 -imputationMethod $imputationMethod.type
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
15 #if $imputationMethod.type == "valueRange"
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
16 -rangeUpperLimit $imputationMethod.rangeUpperLimit
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
17 #end if
49
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 48
diff changeset
18 -plInputFormat $plInputFormat
3
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
19 -potDensFuncType $potDensFuncType.type
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
20 -centerSelectionType $centerSelectionType.type
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
21 -clusteringType $clusteringType.type
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
22 -neighborhoodWindowSize $potDensFuncType.pdf_neighborhoodWindowSize
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
23 -clusterSearchStopCriterium $centerSelectionType.cs_stop_criterion
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
24 -pearsonDistTreshold $potDensFuncType.pdf_pears_treshold
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
25 -pearsonTresholdConfidence $potDensFuncType.pdf_pears_conf
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
26 -pearsonPDReductionThreshold $centerSelectionType.cs_pears_pd_reductionTreshold
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
27 -pearsonPDReductionSlope $centerSelectionType.cs_pears_pd_reductionSlope
28
b1015b9241cd Added option for using retentionMean (micro minutes) for the time dimension
pieter.lukasse@wur.nl
parents: 21
diff changeset
28 -rtDistTolUnit $potDensFuncType.rt_dist_tol_unit.type
b1015b9241cd Added option for using retentionMean (micro minutes) for the time dimension
pieter.lukasse@wur.nl
parents: 21
diff changeset
29 -rtDistTol $potDensFuncType.rt_dist_tol_unit.pdf_rt_toler
36
9018657a9f73 Added "Membership cutoff (0.0 - 1.0)" option
pieter.lukasse@wur.nl
parents: 35
diff changeset
30 -rtDistanceConfidence $potDensFuncType.pdf_scan_conf
9018657a9f73 Added "Membership cutoff (0.0 - 1.0)" option
pieter.lukasse@wur.nl
parents: 35
diff changeset
31 #if $clusteringType.type == "original"
9018657a9f73 Added "Membership cutoff (0.0 - 1.0)" option
pieter.lukasse@wur.nl
parents: 35
diff changeset
32 -clustMembershipCutoff $clusteringType.clust_membership_cutoff
9018657a9f73 Added "Membership cutoff (0.0 - 1.0)" option
pieter.lukasse@wur.nl
parents: 35
diff changeset
33 #end if
3
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
34 -centrotypesOut $centrotypesOut
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
35 -simOut $simOut
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
36 -micOut $micOut
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
37 -mspOut $mspOut
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
38 -classOut $classOut
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
39 -outReport $htmlReportFile
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
40 -outReportPicturesPath $htmlReportFile.files_path
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
41 #if $clusteringType.type == "fuzzyCMeans"
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
42 -fcmMembershipWeightingExponent $clusteringType.fcmMembershipWeightingExponent
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
43 -fcmStopCriterion $clusteringType.fcmStopCriterion
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
44 -fcmCorrelationWeight $clusteringType.fcmCorrelationWeight
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
45 -fcmFinalAssemblyType $clusteringType.finalClusterAssembly.type
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
46 #if $clusteringType.finalClusterAssembly.type == "membershipBased"
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
47 -fcmMembershipCutoff $clusteringType.finalClusterAssembly.fcmMembershipCutoff
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
48 #end if
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
49 #end if
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
50 -verbose "false"
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
51 #if $advancedSettings.settings == True
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
52 -advancedSettings YES
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
53 -saturationLimit $advancedSettings.saturationLimit
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
54 -sampleSelectionSortType $advancedSettings.sampleSelectionSortType
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
55 -simSelectionAlgorithm $advancedSettings.simSelectionAlgorithm
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
56 -simMassFilter "$advancedSettings.simMassFilter"
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
57 -simMembershipThreshold $advancedSettings.simMembershipThreshold
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
58 -simSaturationThreshold $advancedSettings.simSaturationThreshold
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
59 -simAbsenseThreshold $advancedSettings.simAbsenseThreshold
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
60 -micMembershipThreshold $advancedSettings.micMembershipThreshold
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
61 -peakIntensityCorrectionAlgorithm $advancedSettings.peakIntensityCorrectionAlgorithm
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
62 #else
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
63 -advancedSettings YES
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
64 -sampleSelectionSortType SIM_INTENSITY
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
65 -peakIntensityCorrectionAlgorithm CORRELATION_BASED
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
66 #end if
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
67
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
68 </command>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
69 <inputs>
30
60b53f2aa48a Small fixes, added microminutes support to MsClust, removed TIC or MsClust output
pieter.lukasse@wur.nl
parents: 29
diff changeset
70
49
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 48
diff changeset
71 <param name="inputPeaks" type="data" format="txt" label="Ion-wise aligned data (e.g. MetAlign or XCMS/metaMS output data)" />
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 48
diff changeset
72 <param name="plInputFormat" type="select" size="30" label="Data format">
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 48
diff changeset
73 <option value="metalign" selected="true">MetAlign</option>
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 48
diff changeset
74 <option value="xcms">XCMS/metaMS (beta)</option>
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 48
diff changeset
75 </param>
3
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
76 <param name="dataType" type="select" size="30" label="Data type">
49
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 48
diff changeset
77 <option value="gcms" selected="true">GC-MS</option>
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 48
diff changeset
78 <option value="lcms">LC-MS</option>
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 48
diff changeset
79 </param>
3
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
80 <conditional name="imputationMethod">
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
81 <param name="type" type="select" size="30" label="Select the approach used for imputing missing values (optional)" help="select how you generated the values to fill in the data gaps">
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
82 <option value="none" >none</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
83 <option value="metot" selected="true">MeTot</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
84 <option value="valueRange">Values range</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
85 </param>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
86 <when value="valueRange">
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
87 <param name="rangeUpperLimit" type="integer" size="10" value="0" label="Range upper limit" help="values up to this limit will be considered 'generated' values" />
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
88 </when>
19
c068ed713eb9 fixes on <when> tags
pieter.lukasse@wur.nl
parents: 15
diff changeset
89 <when value="metot">
c068ed713eb9 fixes on <when> tags
pieter.lukasse@wur.nl
parents: 15
diff changeset
90 </when>
c068ed713eb9 fixes on <when> tags
pieter.lukasse@wur.nl
parents: 15
diff changeset
91 <when value="none">
c068ed713eb9 fixes on <when> tags
pieter.lukasse@wur.nl
parents: 15
diff changeset
92 </when>
3
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
93 </conditional>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
94 <conditional name="potDensFuncType">
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
95 <param name="type" type="select" size="30" label="Select PD function type =====================================================">
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
96 <option value="original" selected="true">Original</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
97 </param>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
98 <when value="original">
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
99 <param name="pdf_neighborhoodWindowSize" type="integer" size="10" value="200" label="Effective Peaks" />
28
b1015b9241cd Added option for using retentionMean (micro minutes) for the time dimension
pieter.lukasse@wur.nl
parents: 21
diff changeset
100 <conditional name="rt_dist_tol_unit">
b1015b9241cd Added option for using retentionMean (micro minutes) for the time dimension
pieter.lukasse@wur.nl
parents: 21
diff changeset
101 <param name="type" type="select" size="30" label="Peak time unit">
49
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 48
diff changeset
102 <option value="1" selected="true">scan nr (MetAlign)</option>
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 48
diff changeset
103 <option value="2" >(average) micro minutes (MetAlign)</option>
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 48
diff changeset
104 <option value="3" >(average) minutes (XCMS)</option>
28
b1015b9241cd Added option for using retentionMean (micro minutes) for the time dimension
pieter.lukasse@wur.nl
parents: 21
diff changeset
105 </param>
29
0d534bce8e84 small fix
pieter.lukasse@wur.nl
parents: 28
diff changeset
106 <when value="1">
28
b1015b9241cd Added option for using retentionMean (micro minutes) for the time dimension
pieter.lukasse@wur.nl
parents: 21
diff changeset
107 <param name="pdf_rt_toler" type="float" size="10" value="10" label="Peak Width, in scans" />
b1015b9241cd Added option for using retentionMean (micro minutes) for the time dimension
pieter.lukasse@wur.nl
parents: 21
diff changeset
108 </when>
29
0d534bce8e84 small fix
pieter.lukasse@wur.nl
parents: 28
diff changeset
109 <when value="2">
28
b1015b9241cd Added option for using retentionMean (micro minutes) for the time dimension
pieter.lukasse@wur.nl
parents: 21
diff changeset
110 <param name="pdf_rt_toler" type="float" size="10" value="100000" label="Peak Width, in micro minutes" help="e.g. 100,000=6 seconds" />
b1015b9241cd Added option for using retentionMean (micro minutes) for the time dimension
pieter.lukasse@wur.nl
parents: 21
diff changeset
111 </when>
49
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 48
diff changeset
112 <when value="3">
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 48
diff changeset
113 <param name="pdf_rt_toler" type="float" size="10" value="0.1" label="Peak Width, in minutes" help="e.g. 0.1=6 seconds" />
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 48
diff changeset
114 </when>
28
b1015b9241cd Added option for using retentionMean (micro minutes) for the time dimension
pieter.lukasse@wur.nl
parents: 21
diff changeset
115 </conditional>
3
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
116 <param name="pdf_scan_conf" type="float" size="10" value="80" label="Peak Width confidence (0.0 to 99.99)" help="example: 0[no confidence]...50[good guess]...99.9[quite certain])" />
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
117 <param name="pdf_pears_treshold" type="float" size="10" value="0.8" label="Correlation threshold (0.0 - 1.0)" />
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
118 <param name="pdf_pears_conf" type="float" size="10" value="98.0" label="Correlation threshold confidence (0.0 to 99.99)" help="example: 0[no confidence]...50[good guess]...99.9[quite certain])" />
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
119 </when>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
120 </conditional>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
121 <conditional name="centerSelectionType">
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
122 <param name="type" type="select" label="Initial Centers selection type ==================================================" >
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
123 <option value="original" selected="true">Original - Subtractive potential reductions with stop criterion and REUSE tolerances (from PD function)</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
124 </param>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
125 <when value="original">
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
126 <param name="cs_pears_pd_reductionTreshold" type="float" size="10" value="0.8" label="Potential Density reduction (0.0 - 1.0)" />
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
127 <param name="cs_pears_pd_reductionSlope" type="float" size="10" value="0.01" label="Potential Density reduction softness " />
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
128 <param name="cs_stop_criterion" type="float" size="10" value="2" label="Stop Criterion " />
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
129 </when>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
130 </conditional>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
131 <conditional name="clusteringType">
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
132 <param name="type" type="select" label="Classify using ===========================================================">
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
133 <option value="original" selected="true">Original - Fuzzy clustering, keep original centers and REUSE (scan distance) tolerances</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
134 <option value="fuzzyCMeans">(experimental) Fuzzy C-Means - Fuzzy clustering, optimize centers</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
135 </param>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
136 <when value="original">
36
9018657a9f73 Added "Membership cutoff (0.0 - 1.0)" option
pieter.lukasse@wur.nl
parents: 35
diff changeset
137 <param name="clust_membership_cutoff" type="float" size="10" value=""
9018657a9f73 Added "Membership cutoff (0.0 - 1.0)" option
pieter.lukasse@wur.nl
parents: 35
diff changeset
138 label="Membership cutoff (0.0 - 1.0)"
9018657a9f73 Added "Membership cutoff (0.0 - 1.0)" option
pieter.lukasse@wur.nl
parents: 35
diff changeset
139 help="Items with membership below this value are NOT added to the cluster"/>
3
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
140 </when>
19
c068ed713eb9 fixes on <when> tags
pieter.lukasse@wur.nl
parents: 15
diff changeset
141 <!-- one idea would be to have clustering specific tolerance values, not reusing the centrotype selection ones
3
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
142 <when value="originalNewTol">
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
143 <param name="clust_scan_toler" type="float" size="10" value="10" label="Peak Width, in scans" />
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
144 <param name="clust_scan_slope" type="float" size="10" value="2" label="Peak Width margin softness" />
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
145 </when>
19
c068ed713eb9 fixes on <when> tags
pieter.lukasse@wur.nl
parents: 15
diff changeset
146 -->
3
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
147 <when value="fuzzyCMeans">
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
148 <param name="fcmMembershipWeightingExponent" type="float" size="10" value="2.0" label="Membership Weighting Exponent" help="Influences cluster center repositioning in the iterations 1.1 (exploratory) to around 3.0 (conservative)" />
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
149 <param name="fcmStopCriterion" type="float" size="10" value="0.05" label="Stop Criterion" help="When convergence is 'reached' (e.g. 0.05 means memberships only changed with 5% in last iteration)" />
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
150 <param name="fcmCorrelationWeight" type="float" size="10" value="2" label="Correlation weight factor" help="Increase this if you think the correlation is reliable (e.g. you have a high number of samples)" />
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
151 <conditional name="finalClusterAssembly">
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
152 <param name="type" type="select" label="Final cluster assembly" >
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
153 <option value="original" selected="true">Original - distance based</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
154 <option value="membershipBased">Membership based</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
155 </param>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
156 <when value="membershipBased">
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
157 <param name="fcmMembershipCutoff" type="select" label="Maximum allowed peak overlap" >
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
158 <option value="0.05" >~7 clusters</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
159 <option value="0.10" >~5 clusters</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
160 <option value="0.20" >~3 clusters</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
161 </param>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
162 </when>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
163 <when value="original">
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
164 <!-- nothing -->
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
165 </when>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
166 </conditional>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
167 </when>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
168 </conditional>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
169
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
170 <param name="summaryReport" type="boolean" checked="true" label="Generate summary report" help="NB: this will increase the processing time (in some cases up to a few extra minutes)"/>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
171
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
172 <conditional name="advancedSettings">
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
173 <param name="settings" type="boolean" truevalue="Yes" falsevalue="No" checked="false" label="Advanced settings ========================================================"/>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
174 <when value="Yes">
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
175 <param name="saturationLimit" optional="true" type="integer" size="10" label="Saturation limit (optional)" help="fill in if you have saturation problems in your data" />
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
176 <param name="sampleSelectionSortType" type="select" label="Sample selection scheme for spectrum peak intensity correction algorithm (optional/experimental)" help="The intensity values to use to select the samples for each cluster/metabolite in which it is most intense/abundant. These samples are used in the peak intensity correction (see parameter below). Use this option to try to avoid samples that have insufficient signal or saturation." >
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
177 <option value="None">None</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
178 <!-- in order of best FORWARD scoring when tested on /test/data/report_test_sets/(P2) Relative peak heights in spectra/Input (Test set 1) -->
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
179 <option value="SIM_INTENSITY" selected="true">SIM intensities</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
180 <option value="MAX_INTENSITY">Maximum intensities</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
181 <option value="CENTROTYPE_INTENSITY">Centrotype peak intensities</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
182 <option value="MIC_INTENSITY">MIC intensities</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
183 </param>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
184 <param name="peakIntensityCorrectionAlgorithm" type="select" label="Spectrum peak intensity correction algorithm (optional/experimental)" help="Whether spectrum peak heights should be adjusted according to their membership to the cluster or to their correlation to the cluster's centrotype ion" >
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
185 <option value="MEMBERSHIP_BASED">Membership based (msclust 1.0 mode)</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
186 <option value="CORRELATION_BASED" selected="true">Correlation based</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
187 </param>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
188 <param name="simSelectionAlgorithm" type="select" label="SIM selection algorithm (experimental)" help="Set this if you want to deviate from the standard which is: allow shared SIM peaks for GC-MS data, and force unique SIM peaks for LC-MS data">
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
189 <option value="" selected="true"></option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
190 <option value="uniqueSIM">Unique SIM peak</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
191 <option value="sharedSIM">Shared SIM peak</option>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
192 </param>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
193 <param name="simMassFilter" type="text" optional="true" size="30" label="SIM mass exclusion list" help="Comma-separated list of masses NOT to use as SIM peaks. E.g. '73,147,...' " />
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
194 <param name="simMembershipThreshold" optional="true" type="float" size="10" label="SIM membership threshold" help="Minimum membership a peak should have to qualify as a SIM candidate. E.g. 0.8 " />
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
195 <param name="simSaturationThreshold" optional="true" type="float" size="10" label="SIM saturation threshold (%)" help="Maximum % of samples in which a SIM candidate peak may be saturated. If the candidate peak exceeds this threshold, then another peak is chosen. If no peak can be found this criteria, mass 0 is reported" />
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
196 <param name="simAbsenseThreshold" optional="true" type="float" size="10" label="SIM absence threshold (%)" help="Maximum % of samples in which a SIM candidate peak may be absent. If the candidate peak exceeds this threshold, then another peak is chosen. If no peak can be found meeting this criteria, mass 0 is reported" />
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
197
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
198 <param name="micMembershipThreshold" optional="true" type="float" size="10" label="MIC membership threshold" help="Minimum membership a peak should have to be counted in the MIC sum. E.g. 0.8 " />
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
199
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
200 </when>
19
c068ed713eb9 fixes on <when> tags
pieter.lukasse@wur.nl
parents: 15
diff changeset
201 <when value="No">
c068ed713eb9 fixes on <when> tags
pieter.lukasse@wur.nl
parents: 15
diff changeset
202 </when>
3
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
203 </conditional>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
204
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
205
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
206 </inputs>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
207 <outputs>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
208 <data name="centrotypesOut" format="msclust.csv" label="${tool.name} on ${on_string} - centrotypes file"/>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
209 <data name="simOut" format="msclust.csv" label="${tool.name} on ${on_string} - SIM file"/>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
210 <data name="micOut" format="msclust.csv" label="${tool.name} on ${on_string} - MIC file"/>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
211 <data name="mspOut" format="msp" label="${tool.name} on ${on_string} - SPECTRA file"/>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
212 <data name="classOut" format="msclust.csv" label="${tool.name} on ${on_string} - Classification file"/>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
213 <data name="htmlReportFile" format="html" label="${tool.name} on ${on_string} - HTML report">
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
214 <!-- If the expression is false, the file is not created -->
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
215 <filter>( summaryReport == True )</filter>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
216 </data>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
217 </outputs>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
218 <tests>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
219 <!-- find out how to use -->
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
220 </tests>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
221 <help>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
222
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
223 <!-- see also http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#hyperlink-targets -->
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
224
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
225 .. class:: infomark
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
226
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
227 This tool extracts spectra from ion-wise aligned MS(/MS) results. It uses expression profiles and
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
228 retention times of the putative ions to cluster them. Each cluster is then used to generate
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
229 one spectrum containing the clustered ions (peaks).
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
230
4
80075a4c6543 updated image paths
pieter.lukasse@wur.nl
parents: 3
diff changeset
231 .. image:: msclust_summary.png
3
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
232
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
233
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
234 -----
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
235
30
60b53f2aa48a Small fixes, added microminutes support to MsClust, removed TIC or MsClust output
pieter.lukasse@wur.nl
parents: 29
diff changeset
236 **Input**
60b53f2aa48a Small fixes, added microminutes support to MsClust, removed TIC or MsClust output
pieter.lukasse@wur.nl
parents: 29
diff changeset
237
60b53f2aa48a Small fixes, added microminutes support to MsClust, removed TIC or MsClust output
pieter.lukasse@wur.nl
parents: 29
diff changeset
238 The input file should contain the following columns (in this order), followed by the sample intensity columns (one column with the
60b53f2aa48a Small fixes, added microminutes support to MsClust, removed TIC or MsClust output
pieter.lukasse@wur.nl
parents: 29
diff changeset
239 intensity value for each sample):
60b53f2aa48a Small fixes, added microminutes support to MsClust, removed TIC or MsClust output
pieter.lukasse@wur.nl
parents: 29
diff changeset
240
31
31e6e2242d33 small fix in doc
pieter.lukasse@wur.nl
parents: 30
diff changeset
241 *ScanNR*
31e6e2242d33 small fix in doc
pieter.lukasse@wur.nl
parents: 30
diff changeset
242
31e6e2242d33 small fix in doc
pieter.lukasse@wur.nl
parents: 30
diff changeset
243 *Ret(umin)*
31e6e2242d33 small fix in doc
pieter.lukasse@wur.nl
parents: 30
diff changeset
244
31e6e2242d33 small fix in doc
pieter.lukasse@wur.nl
parents: 30
diff changeset
245 *Mass(uD)*
31e6e2242d33 small fix in doc
pieter.lukasse@wur.nl
parents: 30
diff changeset
246
31e6e2242d33 small fix in doc
pieter.lukasse@wur.nl
parents: 30
diff changeset
247 *(Optional)retentionMean*
31e6e2242d33 small fix in doc
pieter.lukasse@wur.nl
parents: 30
diff changeset
248
31e6e2242d33 small fix in doc
pieter.lukasse@wur.nl
parents: 30
diff changeset
249 *(only required if retentionMean is present)retentionSD*
31e6e2242d33 small fix in doc
pieter.lukasse@wur.nl
parents: 30
diff changeset
250
31e6e2242d33 small fix in doc
pieter.lukasse@wur.nl
parents: 30
diff changeset
251 *N sample intensity columns...*
31e6e2242d33 small fix in doc
pieter.lukasse@wur.nl
parents: 30
diff changeset
252
30
60b53f2aa48a Small fixes, added microminutes support to MsClust, removed TIC or MsClust output
pieter.lukasse@wur.nl
parents: 29
diff changeset
253
60b53f2aa48a Small fixes, added microminutes support to MsClust, removed TIC or MsClust output
pieter.lukasse@wur.nl
parents: 29
diff changeset
254 -----
60b53f2aa48a Small fixes, added microminutes support to MsClust, removed TIC or MsClust output
pieter.lukasse@wur.nl
parents: 29
diff changeset
255
3
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
256 **Output**
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
257
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
258 This tools returns a number of ouptut files and a small report.
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
259
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
260 **Parameters index**
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
261
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
262
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
263 *Select the approach used for imputing missing values:* only select this if you have used a specific method to
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
264 fill in the data gaps in the input file. One example is replacing zero values by some randomly generated low value.
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
265 If MeTot is chosen, then a value is considered generated if: the value contains a dot '.' and some number
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
266 other than 0 (zero) after the dot.
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
267
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
268 *Effective Peaks:* Neighborhood window size to consider when calculating density. Smaller values increase
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
269 performance but are less reliable.
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
270
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
271 *Peak Width, in scans:* Scan window width of scans to consider 'close'. One can see this as the
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
272 'tolerated variation in scans' for the apex positions of the fragment peaks composing a cluster.
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
273 Note: if MetAlign was used, this is the variation *after* pre-processing by MetAlign.
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
274
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
275 *Peak Width confidence:* The higher the confidence, the stricter the threshold.
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
276
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
277 *Correlation threshold (0.0 - 1.0):* Tolerance center for pearson distance calculation. The higher this value,
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
278 the higher the correlation between 2 items has to be for them to be considered 'close'.
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
279
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
280 *Correlation threshold confidence:* The higher the confidence, the stricter the threshold. `More...`__
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
281
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
282 *Potential Density reduction (0.0 - 1.0):* Reduction tolerance center for pearson distance calculation.
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
283 The higher this value, the less the low correlated items get reduced, getting a chance to form a cluster of their own.
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
284
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
285 *Potential Density reduction softness:* Reduction curve slope for pearson distance tolerance. Lower
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
286 values = stricter separation at the value determined in 'Potential Density reduction' above
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
287 (TODO review this comment).
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
288
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
289 *Stop Criterion:* When to stop reducing and looking for new clusters. Lower values = more iterations
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
290
13
b9815233960f workaround for pop-up images
pieter.lukasse@wur.nl
parents: 12
diff changeset
291 .. __: javascript:window.open('.. image:: confidence_and_slope_params_explain.png'.replace('.. image:: ', ''),'popUpWindow','height=700,width=800,left=10,top=10,resizable=yes,scrollbars=yes,toolbar=yes,menubar=no,location=no,directories=no,status=yes')
3
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
292
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
293
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
294 -----
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
295
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
296 **Output files described below**
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
297
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
298 -----
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
299
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
300 *SPECTRA:* this file can be submitted to NIST for identification of the spectra.
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
301
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
302 `Click here for more details on the Sample selection and Spectrum peak intensity correction algorithm parameters related to SPECTRA generation`_
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
303
14
4c5ba34c8c1c workaround for pop-up images
pieter.lukasse@wur.nl
parents: 13
diff changeset
304 .. _Click here for more details on the Sample selection and Spectrum peak intensity correction algorithm parameters related to SPECTRA generation: javascript:window.open('.. image:: sample_sel_and_peak_height_correction.png'.replace('.. image:: ', ''),'popUpWindow','height=700,width=800,left=10,top=10,resizable=yes,scrollbars=yes,toolbar=yes,menubar=no,location=no,directories=no,status=yes')
3
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
305
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
306 -----
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
307
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
308 *MIC:* stands for Measured Ions Count -> it contains, for each cluster, the sum of the ion count
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
309 values (corrected by their membership) for all MEASURED cluster ions in the given sample.
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
310
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
311 The MIC for a **cluster i** in **sample s**, where **cluster i** has **n** members is thus:
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
312
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
313 sum ( [intensity of member n in **sample s**] x [membership value of member n in **cluster i** ] )
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
314
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
315 -----
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
316
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
317 *SIM:* stands for Selective Ion Mode -> it contains, for each cluster, the intensity values of the
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
318 most representative member ion peak of this cluster. The most representative member peak is the one with the
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
319 highest membership*average_intensity. This definition leads to conflicts as a peak can have a
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
320 membership in two or more clusters. The assignment of a SIM peak to a cluster depends on
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
321 the configured data type (LC or GC-MS). NB: this can be overruled in the "advanced settings":
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
322
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
323 (1) LC-MS SIM: select SIM peak only once and for the centrotype in which this specific mass has its
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
324 highest membership; for neighboring centrotypes use its "second best SIM", etcetera. In other words,
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
325 if the SIM peak has been identified as the SIM in more than 1 cluster, assign as SIM to the cluster
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
326 with highest membership. Continue searching for other SIM peaks to assign to the other clusters until
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
327 all ambiguities are solved.
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
328
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
329 (2) GC-MS SIM: the SIM peak can be "shared" by multiple clusters. However, the intensity values are corrected
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
330 by the membership value of the peak in the cluster in case the SIM peak is "shared". If the SIM peak is not
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
331 "shared" then the "raw" intensity values of the SIM peak are recorded in the SIM file.
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
332
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
333 `Click here for more details on the SIM output file`_
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
334
15
777c1c2a17a2 workaround for pop-up images
pieter.lukasse@wur.nl
parents: 14
diff changeset
335 .. _Click here for more details on the SIM output file: javascript:window.open('.. image:: sample_SIM.png'.replace('.. image:: ', ''),'popUpWindow','height=700,width=800,left=10,top=10,resizable=yes,scrollbars=yes,toolbar=yes,menubar=no,location=no,directories=no,status=yes')
3
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
336
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
337
41
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents: 37
diff changeset
338 **References**
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents: 37
diff changeset
339
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents: 37
diff changeset
340 If you use this Galaxy tool in work leading to a scientific publication please
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents: 37
diff changeset
341 cite the following papers:
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents: 37
diff changeset
342
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents: 37
diff changeset
343 Y. M. Tikunov, S. Laptenok, R. D. Hall, A. Bovy, and R. C. H. de Vos (2012).
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents: 37
diff changeset
344 MSClust: a tool for unsupervised mass spectra extraction of
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents: 37
diff changeset
345 chromatography-mass spectrometry ion-wise aligned data
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents: 37
diff changeset
346 http://dx.doi.org/10.1007%2Fs11306-011-0368-2
3
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
347
48
26b93438f30e small fix in mass list of CSV files
pieter.lukasse@wur.nl
parents: 41
diff changeset
348 <citations>
26b93438f30e small fix in mass list of CSV files
pieter.lukasse@wur.nl
parents: 41
diff changeset
349 <citation type="doi">10.1007%2Fs11306-011-0368-2</citation> <!-- example
26b93438f30e small fix in mass list of CSV files
pieter.lukasse@wur.nl
parents: 41
diff changeset
350 see also https://wiki.galaxyproject.org/Admin/Tools/ToolConfigSyntax#A.3Ccitations.3E_tag_set
26b93438f30e small fix in mass list of CSV files
pieter.lukasse@wur.nl
parents: 41
diff changeset
351 -->
26b93438f30e small fix in mass list of CSV files
pieter.lukasse@wur.nl
parents: 41
diff changeset
352 </citations>
26b93438f30e small fix in mass list of CSV files
pieter.lukasse@wur.nl
parents: 41
diff changeset
353
26b93438f30e small fix in mass list of CSV files
pieter.lukasse@wur.nl
parents: 41
diff changeset
354
3
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
355 </help>
2c1c9f0d8aa6 using normal versioning
pieter.lukasse@wur.nl
parents:
diff changeset
356 </tool>