annotate OpenSwathChromatogramExtractor.xml @ 1:17e8c91b70d5 draft

Uploaded
author bgruening
date Fri, 10 Oct 2014 18:23:01 -0400
parents 3d84209d3178
children 6ead64a594bd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
1 <?xml version='1.0' encoding='UTF-8'?>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
2 <tool id="OpenSwathChromatogramExtractor" name="OpenSwathChromatogramExtractor" version="1.12.0">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
3 <description>Extract chromatograms (XIC) from a MS2 map file.</description>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
4 <macros>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">OpenSwathChromatogramExtractor</token>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
6 <import>macros.xml</import>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
7 </macros>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
8 <expand macro="stdio"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
9 <expand macro="requirements"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
10 <command>OpenSwathChromatogramExtractor
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
11
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
12 -in ${param_in}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
13 -tr ${param_tr}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
14 -rt_norm ${param_rt_norm}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
15 -out ${param_out}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
16 -min_upper_edge_dist ${param_min_upper_edge_dist}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
17 -mz_window ${param_mz_window}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
18 -rt_window ${param_rt_window}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
19 ${param_is_swath}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
20 ${param_ppm}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
21 ${param_extract_MS1}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
22 -extraction_function ${param_extraction_function}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
23 -threads \${GALAXY_SLOTS:-24}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
24 -model:type ${param_type}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
25 ${param_symmetric_regression}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
26 </command>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
27 <inputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
28 <param name="param_in" type="data" format="mzML" optional="False" size="20" label="Input files separated by blank" help="(-in)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
29 <param name="param_tr" type="data" format="tabular" optional="False" label="transition file ('TraML' or 'csv')" help="(-tr)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
30 <param name="param_rt_norm" type="data" format="" optional="True" label="RT normalization file (how to map the RTs of this run to the ones stored in the library)" help="(-rt_norm)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
31 <param name="param_min_upper_edge_dist" type="float" value="0.0" label="Minimal distance to the edge to still consider a precursor, in Thomson" help="(-min_upper_edge_dist)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
32 <param name="param_mz_window" type="float" min="0.0" optional="True" value="0.05" label="Extraction window in m/z dimension (in Thomson, to use ppm see -ppm flag). This is the full window size, e.g. 100 ppm would extract 50 ppm on either side." help="(-mz_window)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
33 <param name="param_rt_window" type="float" value="-1.0" label="Extraction window in RT dimension (-1 means extract over the whole range). This is the full window size, e.g. a value of 1000 seconds would extract 500 seconds on either side." help="(-rt_window)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
34 <param name="param_is_swath" type="boolean" truevalue="-is_swath true" falsevalue="-is_swath false" checked="false" optional="True" label="Set this flag if the data is SWATH data" help="(-is_swath)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
35 <param name="param_ppm" type="boolean" truevalue="-ppm true" falsevalue="-ppm false" checked="false" optional="True" label="m/z extraction_window is in ppm" help="(-ppm)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
36 <param name="param_extract_MS1" type="boolean" truevalue="-extract_MS1 true" falsevalue="-extract_MS1 false" checked="false" optional="True" label="Extract the MS1 transitions based on the precursor values in the TraML file" help="(-extract_MS1)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
37 <param name="param_extraction_function" type="select" optional="True" value="tophat" label="Function used to extract the signal" help="(-extraction_function)">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
38 <option value="tophat">tophat</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
39 <option value="bartlett">bartlett</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
40 </param>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
41 <param name="param_type" type="select" optional="True" value="linear" label="Type of model" help="(-type)">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
42 <option value="linear">linear</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
43 <option value="b_spline">b_spline</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
44 <option value="interpolated">interpolated</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
45 </param>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
46 <param name="param_symmetric_regression" type="boolean" truevalue="-model:symmetric_regression true" falsevalue="-model:symmetric_regression false" checked="false" optional="True" label="Only for 'linear' model: Perform linear regression on 'y - x' vs. 'y + x', instead of on 'y' vs. 'x'." help="(-symmetric_regression)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
47 </inputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
48 <outputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
49 <data name="param_out" label="output file" format="mzML"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
50 </outputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
51 <help>**What it does**
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
52
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
53 Extract chromatograms (XIC) from a MS2 map file.
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
54
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
55
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
56 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_OpenSwathChromatogramExtractor.html
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
57
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
58 @REFERENCES@
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
59 </help>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
60 </tool>