annotate abims_xcms_fillPeaks.xml @ 2:5815e6e11f9b draft

Uploaded
author mmonsoor
date Tue, 24 Nov 2015 06:26:14 -0500
parents 022df2ef15b0
children 5a54397dbc97
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
1 <tool id="abims_xcms_fillPeaks" name="xcms.fillPeaks" version="2.0.2">
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
2
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
3 <description>Integrate the signal in the region of that peak group not represented and create a new peak</description>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
4
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
5 <requirements>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
6 <requirement type="package" version="3.1.2">R</requirement>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
7 <requirement type="binary">Rscript</requirement>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
8 <requirement type="package" version="1.44.0">xcms</requirement>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
9 <requirement type="package" version="2.1">xcms_w4m_script</requirement>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
10 </requirements>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
11
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
12 <stdio>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
13 <exit_code range="1:" level="fatal" />
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
14 </stdio>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
15
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
16 <command>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
17 xcms.r xfunction fillPeaks image $image method $method &amp;&amp; mv fillPeaks.RData $xsetRData; cat xset.log
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
18 </command>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
19
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
20 <inputs>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
21 <param name="image" type="data" format="rdata.xcms.group,rdata" label="xset RData file" help="output file from another function xcms (group)" />
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
22 <param name="method" type="select" label="Filling method" help="[method] See the help section below">
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
23 <option value="chrom" selected="true">chrom</option>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
24 <option value="MSW" >MSW</option>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
25 </param>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
26 </inputs>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
27
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
28 <outputs>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
29 <data name="xsetRData" format="rdata.xcms.fillpeaks" label="${image.name[:-6]}.fillPeaks.RData" />
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
30 </outputs>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
31
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
32 <tests>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
33 <test>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
34 <param name="image" value="xset.group.retcor.group.RData"/>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
35 <param name="method" value="chrom"/>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
36 <output name="xsetRData" file="xset.group.retcor.group.fillPeaks.RData" />
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
37 </test>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
38 </tests>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
39
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
40 <help>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
41
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
42
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
43 .. class:: infomark
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
44
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
45 **Authors** Colin A. Smith csmith@scripps.edu, Ralf Tautenhahn rtautenh@gmail.com, Steffen Neumann sneumann@ipb-halle.de, Paul Benton hpaul.benton08@imperial.ac.uk and Christopher Conley cjconley@ucdavis.edu
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
46
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
47 .. class:: infomark
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
48
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
49 **Galaxy integration** ABiMS TEAM - UPMC/CNRS - Station biologique de Roscoff and Yann Guitton yann.guitton@univ-nantes.fr - part of Workflow4Metabolomics.org [W4M]
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
50
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
51 | Contact support@workflow4metabolomics.org for any questions or concerns about the Galaxy implementation of this tool.
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
52
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
53
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
54 ---------------------------------------------------
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
55
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
56 ==============
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
57 Xcms.fillPeaks
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
58 ==============
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
59
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
60 -----------
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
61 Description
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
62 -----------
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
63
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
64 For each sample, identify peak groups where that sample is not
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
65 represented. For each of those peak groups, integrate the signal
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
66 in the region of that peak group and create a new peak.
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
67
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
68 According to the type of raw-data there are 2
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
69 different methods available. for filling gcms/lcms data the method
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
70 "chrom" integrates raw-data in the chromatographic domain, whereas
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
71 "MSW" is used for peaklists without retention-time information
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
72 like those from direct-infusion spectra.
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
73
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
74
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
75
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
76 -----------------
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
77 Workflow position
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
78 -----------------
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
79
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
80
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
81 **Upstream tools**
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
82
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
83 ========================= ================= ================== ==========
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
84 Name output file format parameter
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
85 ========================= ================= ================== ==========
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
86 xcms.group xset.group.RData rdata.xcms.group RData file
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
87 ========================= ================= ================== ==========
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
88
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
89
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
90 **Downstream tools**
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
91
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
92 +---------------------------+------------------+-----------------------+
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
93 | Name | Output file | Format |
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
94 +===========================+==================+=======================+
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
95 |xcms.diffreport | xset.retcor.RData| rdata.xcms.fillpeaks |
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
96 +---------------------------+------------------+-----------------------+
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
97 |xcms.annotateDiffreport | xset.retcor.RData| rdata.xcms.fillpeaks |
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
98 +---------------------------+------------------+-----------------------+
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
99
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
100 The output file **xset.fillpeaks** is an RData file. You can continue your analysis using it in **xcms.diffreport** or **xcms.annotateDiffreport** tool as an next step of the workflow.
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
101
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
102
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
103 **General schema of the metabolomic workflow**
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
104
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
105 .. image:: xcms_fillpeaks_workflow.png
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
106
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
107
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
108
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
109 -----------
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
110 Input files
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
111 -----------
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
112
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
113 +---------------------------+-----------------------+
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
114 | Parameter : num + label | Format |
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
115 +===========================+=======================+
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
116 | 1 : RData file | rdata.xcms.group |
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
117 +---------------------------+-----------------------+
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
118
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
119
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
120 ----------
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
121 Parameters
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
122 ----------
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
123
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
124
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
125 Method
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
126 ------
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
127
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
128 **chrom**
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
129
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
130 | This method produces intensity values for those missing samples by integrating raw data in peak group region. In a given group, the start and ending retention time points for integration are defined by the median start and end points of the other detected peaks. The start and end m/z values are similarly determined. Intensities can be still be zero, which is a rather unusual intensity for a peak. This is the case if e.g. the raw data was threshholded, and the integration area contains no actual raw intensities, or if one sample is miscalibrated, such the raw data points are (just) outside the integration area.
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
131 | Importantly, if retention time correction data is available, the alignment information is used to more precisely integrate the propper region of the raw data. If the corrected retention time is beyond the end of the raw data, the value will be not-a-number (NaN).
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
132
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
133 **MSW**
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
134
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
135 | "MSW" is used for peaklists without retention-time information like those from direct-infusion spectra.
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
136
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
137 ------------
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
138 Output files
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
139 ------------
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
140
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
141 xset.fillPeaks.RData : rdata.xcms.fillpeaks format
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
142
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
143 | Rdata file that will be used in the **xcms.diffreport** or **xcms.annotateDiffreport** step of the workflow.
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
144
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
145 ------
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
146
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
147 .. class:: infomark
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
148
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
149 The output file is an group.RData file. You can continue your analysis using it in **xcms.diffreport** or **xcms.annotateDiffreport** tool.
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
150
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
151
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
152 ---------------------------------------------------
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
153
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
154 ---------------
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
155 Working example
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
156 ---------------
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
157
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
158 Input files
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
159 -----------
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
160
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
161 | RData file -> **xset.retcor.RData**
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
162
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
163 Parameters
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
164 ----------
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
165
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
166 | method -> **chrom**
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
167
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
168
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
169 Output files
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
170 ------------
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
171
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
172 | **xset.fillPeaks.RData: RData file**
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
173
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
174
2
5815e6e11f9b Uploaded
mmonsoor
parents: 0
diff changeset
175
5815e6e11f9b Uploaded
mmonsoor
parents: 0
diff changeset
176
0
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
177 </help>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
178
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
179 <citations>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
180 <citation type="doi">10.1021/ac051437y</citation>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
181 <citation type="doi">10.1093/bioinformatics/btu813</citation>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
182 </citations>
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
183
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
184
022df2ef15b0 planemo upload
lecorguille
parents:
diff changeset
185 </tool>