annotate OpenSwathChromatogramExtractor.xml @ 4:60a33af52042 draft default tip

Uploaded
author galaxyp
date Wed, 13 May 2015 21:19:44 -0400
parents 3070d71e0e5c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
1 <?xml version='1.0' encoding='UTF-8'?>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
2 <tool id="OpenSwathChromatogramExtractor" name="OpenSwathChromatogramExtractor" version="2.0.0">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
3 <description>Extract chromatograms (XIC) from a MS2 map file.</description>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
4 <macros>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">OpenSwathChromatogramExtractor</token>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
6 <import>macros.xml</import>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
7 </macros>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
8 <expand macro="stdio"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
9 <expand macro="requirements"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
10 <command>OpenSwathChromatogramExtractor
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
11
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
12 -in
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
13 #for token in $param_in:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
14 $token
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
15 #end for
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
16 #if $param_tr:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
17 -tr $param_tr
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
18 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
19 #if $param_rt_norm:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
20 -rt_norm $param_rt_norm
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
21 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
22 #if $param_out:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
23 -out $param_out
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
24 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
25 #if $param_min_upper_edge_dist:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
26 -min_upper_edge_dist $param_min_upper_edge_dist
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
27 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
28 #if $param_mz_window:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
29 -mz_window $param_mz_window
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
30 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
31 #if $param_rt_window:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
32 -rt_window $param_rt_window
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
33 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
34 #if $param_is_swath:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
35 -is_swath
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
36 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
37 #if $param_ppm:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
38 -ppm
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
39 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
40 #if $param_extract_MS1:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
41 -extract_MS1
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
42 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
43 #if $param_extraction_function:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
44 -extraction_function
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
45 #if " " in str($param_extraction_function):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
46 "$param_extraction_function"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
47 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
48 $param_extraction_function
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
49 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
50 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
51 -threads \${GALAXY_SLOTS:-24}
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
52 #if $param_model_type:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
53 -model:type
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
54 #if " " in str($param_model_type):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
55 "$param_model_type"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
56 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
57 $param_model_type
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
58 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
59 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
60 #if $param_model_symmetric_regression:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
61 -model:symmetric_regression
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
62 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
63 #if $adv_opts.adv_opts_selector=='advanced':
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
64 #if $adv_opts.param_force:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
65 -force
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
66 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
67 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
68 </command>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
69 <inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
70 <param name="param_in" type="data" format="mzml" multiple="true" optional="False" size="30" label="Input files separated by blank" help="(-in) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
71 <sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
72 <valid initial="string.printable">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
73 <remove value="'"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
74 <remove value="&quot;"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
75 </valid>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
76 </sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
77 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
78 <param name="param_tr" type="data" format="tabular,traml" optional="False" label="transition file ('TraML' or 'csv')" help="(-tr) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
79 <param name="param_rt_norm" type="data" format="trafoxml" optional="True" label="RT normalization file (how to map the RTs of this run to the ones stored in the library)" help="(-rt_norm) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
80 <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) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
81 <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," help="(-mz_window) e.g. 100 ppm would extract 50 ppm on either side"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
82 <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," help="(-rt_window) e.g. a value of 1000 seconds would extract 500 seconds on either side"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
83 <param name="param_is_swath" type="boolean" truevalue="-is_swath" falsevalue="" checked="false" optional="True" label="Set this flag if the data is SWATH data" help="(-is_swath) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
84 <param name="param_ppm" type="boolean" truevalue="-ppm" falsevalue="" checked="false" optional="True" label="m/z extraction_window is in ppm" help="(-ppm) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
85 <param name="param_extract_MS1" type="boolean" truevalue="-extract_MS1" falsevalue="" checked="false" optional="True" label="Extract the MS1 transitions based on the precursor values in the TraML file" help="(-extract_MS1) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
86 <param name="param_extraction_function" type="select" optional="True" value="tophat" label="Function used to extract the signal" help="(-extraction_function) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
87 <option value="tophat">tophat</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
88 <option value="bartlett">bartlett</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
89 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
90 <param name="param_model_type" type="select" optional="True" value="linear" label="Type of model" help="(-type) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
91 <option value="linear">linear</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
92 <option value="b_spline">b_spline</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
93 <option value="interpolated">interpolated</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
94 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
95 <param name="param_model_symmetric_regression" type="boolean" truevalue="-model:symmetric_regression" falsevalue="" checked="false" optional="True" label="Only for 'linear' model: Perform linear regression on 'y - x' vs" help="(-symmetric_regression) 'y + x', instead of on 'y' vs. 'x'"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
96 <expand macro="advanced_options">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
97 <param name="param_force" type="boolean" truevalue="-force" falsevalue="" checked="false" optional="True" label="Overwrite tool specific checks" help="(-force) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
98 </expand>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
99 </inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
100 <outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
101 <data name="param_out" format="mzml"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
102 </outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
103 <help>**What it does**
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
104
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
105 Extract chromatograms (XIC) from a MS2 map file.
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
106
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
107
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
108 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_OpenSwathChromatogramExtractor.html</help>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
109 <expand macro="references"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
110 </tool>