Mercurial > repos > lecorguille > xcms_retcor
annotate abims_xcms_retcor.xml @ 29:c013ed353a2f draft
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
author | lecorguille |
---|---|
date | Tue, 13 Feb 2018 04:44:03 -0500 |
parents | 13885e67b123 |
children | 4d6f4cd7c3ef |
rev | line source |
---|---|
29
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
1 <tool id="abims_xcms_retcor" name="xcms.retcor" version="2.1.1"> |
0 | 2 |
3 <description>Retention Time Correction using retcor function from xcms R package </description> | |
4 | |
6
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
5 <macros> |
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
6 <import>macros.xml</import> |
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
7 </macros> |
0 | 8 |
6
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
9 <expand macro="requirements"/> |
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
10 <expand macro="stdio"/> |
0 | 11 |
1 | 12 <command><![CDATA[ |
14
55923d170538
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents:
12
diff
changeset
|
13 @COMMAND_XCMS_SCRIPT@ |
21
51b9f9452794
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b274c5c21db1a6ad63c28d425a7a6bce483a4af4
lecorguille
parents:
18
diff
changeset
|
14 image '$image' |
14
55923d170538
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents:
12
diff
changeset
|
15 xfunction retcor |
1 | 16 |
21
51b9f9452794
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b274c5c21db1a6ad63c28d425a7a6bce483a4af4
lecorguille
parents:
18
diff
changeset
|
17 xsetRdataOutput '$xsetRData' |
29
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
18 ticspdf '$ticsCorPdf' |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
19 bicspdf '$bpcsCorPdf' |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
20 rplotspdf '$rplotsPdf' |
1 | 21 |
22 method $methods.method | |
0 | 23 #if $methods.method == "obiwarp": |
24 profStep $methods.profStep | |
25 #else | |
26 smooth $methods.smooth | |
27 extra $methods.extra | |
28 missing $methods.missing | |
29 #if $methods.options.option == "show": | |
30 span $methods.options.span | |
31 family $methods.options.family | |
32 plottype $methods.options.plottype | |
33 #end if | |
34 #end if | |
10
c7ae34138ee2
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 960f403303e1691bdd6137c46895feb333b36a82
lecorguille
parents:
9
diff
changeset
|
35 |
16
20a75ba4345b
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 22c4e92909198328fc7439ff47e4546a273eb907
lecorguille
parents:
14
diff
changeset
|
36 @COMMAND_FILE_LOAD@ |
10
c7ae34138ee2
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 960f403303e1691bdd6137c46895feb333b36a82
lecorguille
parents:
9
diff
changeset
|
37 |
14
55923d170538
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents:
12
diff
changeset
|
38 @COMMAND_LOG_EXIT@ |
1 | 39 ]]></command> |
0 | 40 |
41 <inputs> | |
42 <param name="image" type="data" format="rdata.xcms.raw,rdata.xcms.group,rdata" label="xset RData file" help="output file from another function xcms (xcmsSet, retcor etc.)" /> | |
43 <conditional name="methods"> | |
44 <param name="method" type="select" label="Method to use for retention time correction" help="[method] See the help section below" > | |
45 <option value="obiwarp" >obiwarp</option> | |
18
8e740205c907
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 717c02f887ce343ca55f862c8020aaf49f5581d8
lecorguille
parents:
16
diff
changeset
|
46 <option value="peakgroups" selected="true">peakgroups</option> |
0 | 47 </param> |
48 <when value="obiwarp"> | |
49 <param name="profStep" type="float" value="1" label="Step size (in m/z)" help="[profStep] to use for profile generation from the raw data files" /> | |
14
55923d170538
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents:
12
diff
changeset
|
50 </when> |
55923d170538
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents:
12
diff
changeset
|
51 <when value="peakgroups"> |
0 | 52 <param name="smooth" type="select" label="Smooth method" help="[smooth] either 'loess’ for non-linear alignment or ‘linear’ for linear alignment" > |
53 <option value="loess">loess</option> | |
54 <option value="linear">linear</option> | |
55 </param> | |
56 <param name="extra" type="integer" value="1" label="Number of extra peaks to allow in retention time correction correction groups" help="[extra]" /> | |
57 <param name="missing" type="integer" value="1" label="Number of missing samples to allow in retention time correction groups" help="[missing]" /> | |
6
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
58 |
0 | 59 <conditional name="options"> |
60 <param name="option" type="select" label="Advanced options"> | |
61 <option value="show">show</option> | |
62 <option value="hide" selected="true">hide</option> | |
63 </param> | |
64 <when value="show"> | |
65 <param name="span" type="float" value="0.2" label="Degree of smoothing for local polynomial regression fitting" help="[span]"/> | |
14
55923d170538
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents:
12
diff
changeset
|
66 |
1 | 67 <param name="family" type="select" label="Family" help="[family] if gaussian fitting is by least-squares with no outlier removal, and if symmetric a re descending M estimator is used with Tukey's biweight function, allowing outlier removal"> |
68 <option value="gaussian" selected="true">gaussian</option> | |
69 <option value="symmetric">symmetric</option> | |
70 </param> | |
0 | 71 |
1 | 72 <param name="plottype" type="select" help="[plottype] if deviation plot retention time deviation points and regression fit, and if mdevden also plot peak overall peak density and retention time correction peak density"> |
0 | 73 <option value="none" selected="true">none</option> |
74 <option value="deviation">deviation</option> | |
75 <option value="mdevden">mdevden</option> | |
76 </param> | |
6
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
77 |
0 | 78 </when> |
1 | 79 <when value="hide"> |
80 </when> | |
0 | 81 </conditional> |
82 </when> | |
83 </conditional> | |
10
c7ae34138ee2
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 960f403303e1691bdd6137c46895feb333b36a82
lecorguille
parents:
9
diff
changeset
|
84 |
22
411d2b9ea412
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 87dc789d7cd70a3733a1ad0b5a427f4d5905795d
lecorguille
parents:
21
diff
changeset
|
85 <expand macro="input_file_load"/> |
10
c7ae34138ee2
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 960f403303e1691bdd6137c46895feb333b36a82
lecorguille
parents:
9
diff
changeset
|
86 |
0 | 87 </inputs> |
88 | |
89 <outputs> | |
90 <data name="xsetRData" format="rdata.xcms.retcor" label="${image.name[:-6]}.retcor.RData" /> | |
29
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
91 <data name="rplotsPdf" format="pdf" label="${image.name[:-6]}.retcor.Rplots.pdf"> |
0 | 92 <filter>(methods['method'] == 'peakgroups')</filter> |
29
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
93 <filter>(options['option'] == 'show')</filter> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
94 <filter>(family == 'symmetric')</filter> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
95 <filter>(plottype != 'none')</filter> |
0 | 96 </data> |
29
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
97 <data name="ticsCorPdf" format="pdf" label="${image.name[:-6]}.retcor.TICs_corrected.pdf" /> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
98 <data name="bpcsCorPdf" format="pdf" label="${image.name[:-6]}.retcor.BPCs_corrected.pdf" /> |
1 | 99 <data name="log" format="txt" label="xset.log.txt" hidden="true" /> |
0 | 100 </outputs> |
14
55923d170538
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents:
12
diff
changeset
|
101 |
0 | 102 <tests> |
9
14242e316953
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
103 <!--<test> |
0 | 104 <param name="image" value="xset.group.RData"/> |
6
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
105 <param name="methods|method" value="peakgroups"/> |
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
106 <param name="methods|smooth" value="loess"/> |
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
107 <param name="methods|extra" value="1"/> |
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
108 <param name="methods|missing" value="1"/> |
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
109 <param name="methods|options|option" value="show"/> |
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
110 <param name="methods|options|span" value="0.2"/> |
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
111 <param name="methods|options|family" value="gaussian"/> |
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
112 <param name="methods|options|plottype" value="deviation"/> |
10
c7ae34138ee2
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 960f403303e1691bdd6137c46895feb333b36a82
lecorguille
parents:
9
diff
changeset
|
113 <param name="zipfile_load_conditional|zipfile_load_select" value="yes" /> |
c7ae34138ee2
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 960f403303e1691bdd6137c46895feb333b36a82
lecorguille
parents:
9
diff
changeset
|
114 <param name="zipfile_load_conditional|zip_file" value="sacuri_dir_root.zip" ftype="zip" /> |
1 | 115 <output name="log"> |
116 <assert_contents> | |
6
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
117 <has_text text="object with 4 samples" /> |
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
118 <has_text text="Time range: 0.2-1140.1 seconds (0-19 minutes)" /> |
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
119 <has_text text="Mass range: 50.0021-999.9863 m/z" /> |
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
120 <has_text text="Peaks: 59359 (about 14840 per sample)" /> |
1 | 121 <has_text text="Peak Groups: 0" /> |
122 <has_text text="Sample classes: bio, blank" /> | |
123 </assert_contents> | |
124 </output> | |
9
14242e316953
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
125 </test>--> |
14242e316953
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
126 <test> |
14242e316953
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
127 <param name="image" value="faahKO.xset.group.RData"/> |
29
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
128 <param name="methods|method" value="peakgroups"/> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
129 <param name="methods|smooth" value="loess"/> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
130 <param name="methods|extra" value="1"/> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
131 <param name="methods|missing" value="1"/> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
132 <param name="methods|options|option" value="show"/> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
133 <param name="methods|options|span" value="0.2"/> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
134 <param name="methods|options|family" value="gaussian"/> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
135 <param name="methods|options|plottype" value="deviation"/> |
22
411d2b9ea412
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 87dc789d7cd70a3733a1ad0b5a427f4d5905795d
lecorguille
parents:
21
diff
changeset
|
136 <expand macro="test_file_load_zip"/> |
29
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
137 <output name="log"> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
138 <assert_contents> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
139 <has_text text="object with 4 samples" /> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
140 <has_text text="Time range: 2507.7-4481.7 seconds (41.8-74.7 minutes)" /> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
141 <has_text text="Mass range: 200.1-600 m/z" /> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
142 <has_text text="Peaks: 9251 (about 2313 per sample)" /> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
143 <has_text text="Peak Groups: 0" /> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
144 <has_text text="Sample classes: KO, WT" /> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
145 </assert_contents> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
146 </output> |
16
20a75ba4345b
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 22c4e92909198328fc7439ff47e4546a273eb907
lecorguille
parents:
14
diff
changeset
|
147 </test> |
20a75ba4345b
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 22c4e92909198328fc7439ff47e4546a273eb907
lecorguille
parents:
14
diff
changeset
|
148 <test> |
20a75ba4345b
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 22c4e92909198328fc7439ff47e4546a273eb907
lecorguille
parents:
14
diff
changeset
|
149 <param name="image" value="faahKO-single-class.xset.group.RData"/> |
29
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
150 <param name="methods|method" value="peakgroups"/> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
151 <param name="methods|smooth" value="loess"/> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
152 <param name="methods|extra" value="1"/> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
153 <param name="methods|missing" value="1"/> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
154 <param name="methods|options|option" value="show"/> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
155 <param name="methods|options|span" value="0.2"/> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
156 <param name="methods|options|family" value="gaussian"/> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
157 <param name="methods|options|plottype" value="deviation"/> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
158 <expand macro="test_file_load_single"/> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
159 <output name="log"> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
160 <assert_contents> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
161 <has_text text="object with 4 samples" /> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
162 <has_text text="Time range: 2507.7-4481.7 seconds (41.8-74.7 minutes)" /> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
163 <has_text text="Mass range: 200.1-600 m/z" /> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
164 <has_text text="Peaks: 9251 (about 2313 per sample)" /> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
165 <has_text text="Peak Groups: 0" /> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
166 <has_text text="Sample classes: KO, WT" /> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
167 </assert_contents> |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
168 </output> |
0 | 169 </test> |
170 </tests> | |
171 | |
1 | 172 <help><![CDATA[ |
14
55923d170538
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents:
12
diff
changeset
|
173 |
6
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
174 @HELP_AUTHORS@ |
0 | 175 |
176 =========== | |
177 Xcms.retcor | |
178 =========== | |
179 | |
29
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
180 ----------- |
0 | 181 Description |
182 ----------- | |
183 | |
14
55923d170538
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents:
12
diff
changeset
|
184 After matching peaks into groups, xcms can use those groups to identify and correct |
55923d170538
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents:
12
diff
changeset
|
185 correlated drifts in retention time from run to run. The aligned peaks can then be |
55923d170538
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents:
12
diff
changeset
|
186 used for a second pass of peak grouping which will be more accurate than the first. |
55923d170538
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents:
12
diff
changeset
|
187 The whole process can be repeated in an iterative fashion. Not all peak groups will be helpful |
55923d170538
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents:
12
diff
changeset
|
188 for identifying retention time drifts. Some groups may be missing peaks from a large |
55923d170538
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents:
12
diff
changeset
|
189 fraction of samples and thus provide an incomplete picture of the drift at that time point. |
0 | 190 Still others may contain multiple peaks from the same sample, which is a sign of impropper grouping. |
191 | |
192 .. class:: warningmark | |
193 | |
194 **After an retcor step, it is mandatory to do a group step, otherwise the rest of the workflow will not work with the RData file. (the initial peak grouping becomes invalid and is | |
195 discarded)** | |
196 | |
197 | |
198 | |
29
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
199 ----------------- |
0 | 200 Workflow position |
201 ----------------- | |
202 | |
203 | |
204 **Upstream tools** | |
205 | |
29
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
206 ========================= ================= ======= ========== |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
207 Name output file format parameter |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
208 ========================= ================= ======= ========== |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
209 xcms.group xset.group.RData RData RData file |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
210 ========================= ================= ======= ========== |
0 | 211 |
212 | |
213 **Downstream tools** | |
214 | |
215 +---------------------------+------------------+--------+ | |
216 | Name | Output file | Format | | |
217 +===========================+==================+========+ | |
218 |xcms.group | xset.retcor.RData| RData | | |
219 +---------------------------+------------------+--------+ | |
220 | |
29
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
221 The output file **xset.retcor.RData** is an RData file. You can continue your analysis using it in **xcms.group** tool as an next step. |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
222 |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
223 |
0 | 224 **General schema of the metabolomic workflow** |
225 | |
226 .. image:: xcms_retcor_workflow.png | |
227 | |
228 | |
229 ----------- | |
230 Input files | |
231 ----------- | |
232 | |
233 +---------------------------+----------------------+ | |
234 | Parameter : num + label | Format | | |
235 +===========================+======================+ | |
236 | 1 : RData file | rdata.xcms.group | | |
237 +---------------------------+----------------------+ | |
238 | |
239 | |
240 ---------- | |
241 Parameters | |
242 ---------- | |
243 | |
244 Method | |
245 ------ | |
246 | |
247 **peakgroups** | |
248 | |
249 | xcms ignores those groups by only considering well-behaved peak groups which are missing at most one sample and have at most one extra peak. (Those values can be changed with the **missing** and **extra** arguments.) | |
250 | For each of those well-behaved groups, the algorithm calculates a median retention time and, for every sample, a deviation from that median. Within a sample, the observed deviation generally changes over time in a nonlinear fashion. Those changes are approximated using a local polynomial regression technique implemented in the **loess** function. By default, the curve fitting is done using least-squares on all data points. | |
251 | However, it is possible to enable outlier detection and removal by setting the **family** argument to **symmetric**. | |
252 | |
253 **obiwarp** | |
254 | |
255 | Calculate retention time deviations for each sample using the obiwarp code at "http://obi-warp.sourceforge.net/". This function is able to align multiple samples by a center-star strategy. Ordered Bijective Interpolated Warping (OBI-Warp) aligns matrices along a single axis using Dynamic Time Warping (DTW) and a one-to-one (bijective) interpolated warp function. OBI-Warp harnesses the non-linear, comprehensive alignment power of DTW and builds on the discrete, non-bijective output of DTW to give natural interpolants that can be used across multiple datasets. | |
256 | For the original publication see :**Chromatographic Alignment of ESI-LC-MS Proteomics Data Sets by Ordered Bijective Interpo-lated Warping John T. Prince and, Edward M. Marcotte Analytical Chemistry 2006 78 (17), 6140-6152.** | |
257 | |
258 | |
259 ------------ | |
260 Output files | |
261 ------------ | |
262 | |
29
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
263 xset.group.retcor.TICs_corrected.pdf |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
264 |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
265 | "Total Ion Chromatograms" graph in pdf format,corrected after a retcor step. |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
266 |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
267 xset.group.retcor.BPCs_corrected.pdf |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
268 |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
269 | "Total Io"Base Peak Chromatograms" graph in pdf format,corrected after a retcor step |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
270 |
0 | 271 xset.group.retcor.RData: rdata.xcms.retcor format |
272 | |
273 | Rdata file that will be necessary in the **xcms.group** step of the workflow. | |
14
55923d170538
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents:
12
diff
changeset
|
274 |
29
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
275 |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
276 ------ |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
277 |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
278 .. class:: infomark |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
279 |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
280 The output file is an xset.retcor.RData file. You can continue your analysis using it in **xcms.fillPeaks** tool. |
0 | 281 |
14
55923d170538
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents:
12
diff
changeset
|
282 |
0 | 283 --------------------------------------------------- |
284 | |
285 --------------- | |
286 Working example | |
287 --------------- | |
288 | |
289 Input files | |
290 ----------- | |
291 | |
292 | RData file -> **xset.group.RData** | |
293 | |
294 Parameters | |
295 ---------- | |
296 | |
29
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
297 | Method: -> **peakgroups** |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
298 | smooth: -> **loess** |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
299 | extra: -> **1** |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
300 | missing -> **1** |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
301 | Advanced options: -> **show** |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
302 | span -> **0.2** |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
303 | family -> **gaussian** |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
304 | plottype -> **deviation** |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
305 |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
306 |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
307 Output files |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
308 ------------ |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
309 |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
310 | **1) xset.group.retcor.RData: RData file** |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
311 |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
312 | **2) Example of an xset.group.retcor.TICs_corrected pdf file** |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
313 |
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
314 .. image:: xcms_retcor.png |
0 | 315 |
5 | 316 |
317 --------------------------------------------------- | |
318 | |
319 Changelog/News | |
320 -------------- | |
321 | |
29
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
322 **Version 2.1.1 - 29/11/2017** |
27
30410a052ab3
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit bff1445c9b00ccdbe05ee3dc6ed24221033384b9
lecorguille
parents:
22
diff
changeset
|
323 |
29
c013ed353a2f
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents:
28
diff
changeset
|
324 - BUGFIX: To avoid issues with accented letter in the parentFile tag of the mzXML files, we changed a hidden mechanim to LC_ALL=C |
27
30410a052ab3
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit bff1445c9b00ccdbe05ee3dc6ed24221033384b9
lecorguille
parents:
22
diff
changeset
|
325 |
16
20a75ba4345b
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 22c4e92909198328fc7439ff47e4546a273eb907
lecorguille
parents:
14
diff
changeset
|
326 **Version 2.1.0 - 03/02/2017** |
20a75ba4345b
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 22c4e92909198328fc7439ff47e4546a273eb907
lecorguille
parents:
14
diff
changeset
|
327 |
20a75ba4345b
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 22c4e92909198328fc7439ff47e4546a273eb907
lecorguille
parents:
14
diff
changeset
|
328 - IMPROVEMENT: xcms.retcor can deal with merged individual data |
20a75ba4345b
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 22c4e92909198328fc7439ff47e4546a273eb907
lecorguille
parents:
14
diff
changeset
|
329 |
14
55923d170538
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents:
12
diff
changeset
|
330 **Version 2.0.8 - 22/12/2016** |
55923d170538
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents:
12
diff
changeset
|
331 |
55923d170538
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents:
12
diff
changeset
|
332 - BUGFIX: when having only one group (i.e. one folder of raw data) the BPC and TIC pdf files do not contain any graph |
55923d170538
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents:
12
diff
changeset
|
333 |
12
aee5648dc924
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents:
10
diff
changeset
|
334 **Version 2.0.7 - 06/07/2016** |
aee5648dc924
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents:
10
diff
changeset
|
335 |
aee5648dc924
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents:
10
diff
changeset
|
336 - UPGRADE: upgrate the xcms version from 1.44.0 to 1.46.0 |
aee5648dc924
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents:
10
diff
changeset
|
337 |
6
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
338 **Version 2.0.6 - 04/04/2016** |
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
339 |
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
340 - TEST: refactoring to pass planemo test using conda dependencies |
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
341 |
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
342 |
5 | 343 **Version 2.0.5 - 10/02/2016** |
344 | |
345 - BUGFIX: better management of errors. Datasets remained green although the process failed | |
346 | |
347 - BUGFIX: some pdf remained empty even when the process succeed | |
348 | |
349 - UPDATE: refactoring of internal management of inputs/outputs | |
350 | |
351 - UPDATE: refactoring to feed the new report tool | |
352 | |
353 | |
354 **Version 2.0.2 - 02/06/2015** | |
355 | |
356 - 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. | |
357 | |
358 - IMPROVEMENT: parameter labels have changed to facilitate their reading. | |
359 | |
360 | |
1 | 361 ]]></help> |
0 | 362 |
6
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
363 |
fcd93f47dcbf
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
364 <expand macro="citation" /> |
0 | 365 |
366 </tool> |