annotate abims_xcms_group.xml @ 4:2db1d1d0f131 draft

planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
author lecorguille
date Fri, 08 Apr 2016 10:39:09 -0400
parents 98e33cdf0eb1
children 0306a96cc446
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
1 <tool id="abims_xcms_group" name="xcms.group" version="2.0.5">
0
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
2
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
3 <description>Group peaks together across samples using overlapping m/z bins and calculation of smoothed peak distributions in chromatographic time.</description>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
4
4
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
5 <macros>
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
6 <import>macros.xml</import>
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
7 </macros>
0
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
8
4
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
9 <expand macro="requirements"/>
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
10 <expand macro="stdio"/>
0
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
11
3
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
12 <command><![CDATA[
4
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
13 @COMMAND_XCMS_SCRIPT@
3
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
14 xfunction group
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
15 image $image
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
16
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
17 xsetRdataOutput $xsetRData
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
18 rplotspdf $rplotsPdf
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
19
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
20 method $methods.method sleep 0.001
0
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
21 #if $methods.method == "density":
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
22 ## minsamp $methods.minsamp
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
23 minfrac $methods.minfrac
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
24 bw $methods.bw
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
25 mzwid $methods.mzwid
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
26 #if $methods.density_options.option == "show":
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
27 max $methods.density_options.max
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
28 #end if
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
29 #elif $methods.method == "mzClust":
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
30 mzppm $methods.mzppm
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
31 mzabs $methods.mzabs
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
32 minfrac $methods.minfrac
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
33 ## minsamp $methods.minsamp
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
34 #else:
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
35 mzVsRTbalance $methods.mzVsRTbalance
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
36 mzCheck $methods.mzCheck
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
37 rtCheck $methods.rtCheck
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
38 kNN $methods.kNN
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
39 #end if
4
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
40 @COMMAND_LOG_EXIT@
3
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
41 ]]></command>
0
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
42
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
43 <inputs>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
44 <param name="image" type="data" format="rdata.xcms.raw,rdata.xcms.group,rdata.xcms.retcor,rdata" label="xset RData file" help="output file from another function xcms (xcmsSet, retcor etc.)" />
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
45 <conditional name="methods">
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
46 <param name="method" type="select" label="Method to use for grouping" help="[method] See the help section below">
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
47 <option value="density" selected="true">density</option>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
48 <option value="mzClust" >mzClust</option>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
49 <option value="nearest" >nearest</option>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
50 </param>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
51 <when value="density">
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
52 <param name="bw" type="integer" value="30" label="Bandwidth" help="[bw] bandwidth (standard deviation or half width at half maximum) of gaussian smoothing kernel to apply to the peak density chromatogram" />
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
53 <param name="minfrac" type="float" value="0.5" label="Minimum fraction of samples necessary" help="[minfrac] in at least one of the sample groups for it to be a valid group" />
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
54 <param name="mzwid" type="float" value="0.25" label="Width of overlapping m/z slices" help="[mzwid] to use for creating peak density chromatograms and grouping peaks across samples " />
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
55 <!--
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
56 <param name="minsamp" type="hidden" value="1" label="minsamp" help="minimum number of samples necessary in at least one of the sample groups for it to be a valid group " />
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
57 -->
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
58 <conditional name="density_options">
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
59 <param name="option" type="select" label="Advanced options">
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
60 <option value="show">show</option>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
61 <option value="hide" selected="true">hide</option>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
62 </param>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
63 <when value="show">
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
64 <param name="max" type="integer" value="5" label="Maximum number of groups to identify in a single m/z slice" help="[max]" />
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
65 </when>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
66 <when value="hide">
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
67 </when>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
68 </conditional>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
69
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
70 </when>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
71 <when value="mzClust">
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
72 <param name="mzppm" type="integer" value="20 " label="Relative error used for clustering/grouping in ppm" help="[mzppm]" />
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
73 <param name="mzabs" type="float" value="0" label="Absolute error used for clustering/grouping" help="[mzabs]" />
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
74 <param name="minfrac" type="float" value="0" label="Minimum fraction of each class in one bin" help="[minfrac] minimum fraction of samples necessary in at least one of the sample groups for it to be a valid group" />
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
75 <!--
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
76 <param name="minsamp" type="hidden" value="1" label="minsamp" help="minimum number of samples necessary in at least one of the sample groups for it to be a valid group " />
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
77 -->
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
78 </when>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
79 <when value="nearest">
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
80 <param name="mzVsRTbalance" type="integer" value="10 " label="Multiplicator for mz value before calculating the (euclidean) distance between two peaks." help="[mzVsRTbalance]" />
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
81 <param name="mzCheck" type="float" value="0.2" label="Maximum tolerated distance for mz" help="[mzCheck]" />
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
82 <param name="rtCheck" type="integer" value="15" label="Maximum tolerated distance for RT" help="[rtCheck]" />
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
83 <param name="kNN" type="integer" value="10" label="Number of nearest Neighbours to check" help="[kNN]" />
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
84 </when>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
85 </conditional>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
86 <!--
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
87 <param name="sleepy" type="float" value="0.001" label="sleep" help="seconds to pause between plotting successive steps of the peak grouping algorithm. peaks are plotted as points showing relative intensity. identified groups are flanked by dotted vertical lines">
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
88 <validator type="in_range" message="Must be more than 0" min="0.001" max="inf"/>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
89 </param>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
90 -->
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
91
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
92 </inputs>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
93
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
94 <outputs>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
95 <data name="xsetRData" format="rdata.xcms.group" label="${image.name[:-6]}.group.RData"/>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
96 <data name="rplotsPdf" format="pdf" label="${image.name[:-6]}.group.Rplots.pdf"/>
3
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
97 <data name="log" format="txt" label="xset.log.txt" hidden="true" />
0
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
98 </outputs>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
99
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
100 <tests>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
101 <test>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
102 <param name="image" value="xset.RData"/>
4
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
103 <param name="methods|method" value="density"/>
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
104 <param name="methods|bw" value="5"/>
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
105 <param name="methods|minfrac" value="0.3"/>
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
106 <param name="methods|mzwid" value="0.01"/>
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
107 <param name="methods|density_options|option" value="show"/>
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
108 <param name="methods|density_options|max" value="50"/>
3
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
109 <output name="log">
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
110 <assert_contents>
4
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
111 <has_text text="object with 4 samples" />
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
112 <has_text text="Time range: 0.7-1139.7 seconds (0-19 minutes)" />
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
113 <has_text text="Mass range: 50.0021-999.9863 m/z" />
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
114 <has_text text="Peaks: 59359 (about 14840 per sample)" />
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
115 <has_text text="Peak Groups: 48998" />
3
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
116 <has_text text="Sample classes: bio, blank" />
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
117 </assert_contents>
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
118 </output>
4
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
119 </test>
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
120 <test>
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
121 <param name="image" value="xset.group.retcor.RData"/>
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
122 <param name="methods|method" value="density"/>
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
123 <param name="methods|bw" value="5"/>
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
124 <param name="methods|minfrac" value="0.3"/>
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
125 <param name="methods|mzwid" value="0.01"/>
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
126 <param name="methods|density_options|option" value="show"/>
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
127 <param name="methods|density_options|max" value="50"/>
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
128 <output name="log">
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
129 <assert_contents>
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
130 <has_text text="object with 4 samples" />
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
131 <has_text text="Time range: 0.2-1140.1 seconds (0-19 minutes)" />
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
132 <has_text text="Mass range: 50.0021-999.9863 m/z" />
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
133 <has_text text="Peaks: 59359 (about 14840 per sample)" />
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
134 <has_text text="Peak Groups: 48958" />
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
135 <has_text text="Sample classes: bio, blank" />
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
136 </assert_contents>
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
137 </output>
0
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
138 </test>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
139 </tests>
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
140
3
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
141 <help><![CDATA[
0
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
142
4
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
143 @HELP_AUTHORS@
0
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
144
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
145 ==========
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
146 Xcms.Group
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
147 ==========
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
148
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
149 -----------
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
150 Description
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
151 -----------
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
152
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
153 After peak identification with xcmsSet, this tool groups the peaks which represent the same analyte across samples using overlapping m/z bins and calculation of smoothed peak distributions in chromatographic time. Allows rejection of features, which are only partially detected within the replicates of a sample class.
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
154
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
155
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
156
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
157 -----------------
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
158 Workflow position
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
159 -----------------
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
160
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
161 **Upstream tools**
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
162
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
163 ========================= ================= =================== ==========
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
164 Name output file format parameter
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
165 ========================= ================= =================== ==========
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
166 xcms.xcmsSet xset.RData rdata.xcms.raw RData file
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
167 ------------------------- ----------------- ------------------- ----------
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
168 xcms.retcor xset.RData rdata.xcms.retcor RData file
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
169 ========================= ================= =================== ==========
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
170
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
171
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
172 **Downstream tools**
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
173
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
174 +---------------------------+--------------------------------------+
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
175 | Name | Output file | Format |
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
176 +===========================+=================+====================+
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
177 |xcms.retcor | xset.RData | rdata.xcms.group |
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
178 +---------------------------+--------------------------------------+
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
179 |xcms.fillPeaks | xset.RData | rdata.xcms.group |
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
180 +---------------------------+--------------------------------------+
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
181
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
182 The output file is an xcmsSet.RData file. You can continue your analysis using it in **xcms.retcor** tool as an next step and then **xcms.fillPeaks**.
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
183
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
184 **General schema of the metabolomic workflow**
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
185
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
186 .. image:: xcms_group_workflow.png
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
187
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
188
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
189 -----------
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
190 Input files
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
191 -----------
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
192
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
193 +---------------------------+-----------------------+
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
194 | Parameter : num + label | Format |
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
195 +===========================+=======================+
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
196 | 1 : RData file | rdata.xcms.group |
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
197 +---------------------------+-----------------------+
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
198
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
199
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
200 ----------
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
201 Parameters
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
202 ----------
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
203
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
204 Method to use for grouping
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
205 --------------------------
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
206
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
207 **mzClust**
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
208
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
209 | Runs high resolution alignment on single spectra samples stored in the RData file generated by the **xcmsSet tool**.
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
210
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
211 **density**
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
212
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
213 | Groups peaks together across samples using overlapping m/z bins and calculation of smoothed peak distributions in chromatographic time.
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
214
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
215 **nearest**
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
216
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
217 | Groups peaks together across samples by creating a master peak list and assigning corresponding peaks from all samples. It is inspired by the alignment algorithm of mzMine.
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
218
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
219
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
220 ------------
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
221 Output files
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
222 ------------
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
223
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
224 xset.group.Rplots.pdf
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
225
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
226 xset.group.RData: rdata.xcms.group format
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
227
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
228 | Rdata file that will be necessary in the third and fourth step of the workflow (xcms.retcor and xcms.fillpeaks).
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
229
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
230
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
231 ------
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
232
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
233 .. class:: infomark
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
234
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
235 The output file is an xset.group.RData file. You can continue your analysis using it in **xcms.retcor** tool.
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
236
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
237
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
238 ---------------------------------------------------
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
239
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
240
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
241 ---------------
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
242 Working example
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
243 ---------------
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
244
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
245 Input files
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
246 -----------
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
247
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
248 | RData file -> **xset.RData**
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
249
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
250 Parameters
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
251 ----------
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
252
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
253 | Method -> **density**
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
254 | bw -> **5**
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
255 | minfrac -> **0.3**
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
256 | mzwid -> **0.01**
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
257 | Advanced options: **show**
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
258 | max -> **50**
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
259
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
260
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
261 Output files
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
262 ------------
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
263
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
264 | **1) xset.RData: RData file**
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
265
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
266 | **2) Example of an xset.group.Rplots pdf file**
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
267
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
268 .. image:: xcms_group.png
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
269 :width: 700
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
270
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
271
3
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
272 ---------------------------------------------------
2
ed149026836e Uploaded
mmonsoor
parents: 0
diff changeset
273
3
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
274 Changelog/News
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
275 --------------
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
276
4
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
277 **Version 2.0.5 - 04/04/2016**
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
278
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
279 - TEST: refactoring to pass planemo test using conda dependencies
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
280
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
281
3
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
282 **Version 2.0.4 - 10/02/2016**
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
283
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
284 - BUGFIX: better management of errors. Datasets remained green although the process failed
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
285
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
286 - UPDATE: refactoring of internal management of inputs/outputs
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
287
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
288 - UPDATE: refactoring to feed the new report tool
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
289
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
290
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
291 **Version 2.0.2 - 02/06/2015**
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
292
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
293 - IMPROVEMENT: new datatype/dataset formats (rdata.xcms.raw, rdata.xcms.group, rdata.xcms.retcor ...) will facilitate the sequence of tools and so avoid incompatibility errors.
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
294
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
295 - IMPROVEMENT: parameter labels have changed to facilitate their reading.
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
296
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
297
98e33cdf0eb1 planemo upload
lecorguille
parents: 2
diff changeset
298 ]]></help>
0
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
299
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
300
4
2db1d1d0f131 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
301 <expand macro="citation" />
0
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
302
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
303
f3f97841564f Uploaded
lecorguille
parents:
diff changeset
304 </tool>