annotate FeatureLinkerLabeled.xml @ 3:ec62782f6c68 draft

Uploaded
author bgruening
date Mon, 13 Oct 2014 10:18:22 -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="FeatureLinkerLabeled" name="FeatureLinkerLabeled" version="1.12.0">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
3 <description>Groups corresponding isotope-labeled features in a feature map.</description>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
4 <macros>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">FeatureLinkerLabeled</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>FeatureLinkerLabeled
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
11
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
12 -in ${param_in}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
13 -out ${param_out}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
14 -threads \${GALAXY_SLOTS:-24}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
15 ${param_rt_estimate}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
16 -algorithm:rt_pair_dist ${param_rt_pair_dist}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
17 -algorithm:rt_dev_low ${param_rt_dev_low}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
18 -algorithm:rt_dev_high ${param_rt_dev_high}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
19 -algorithm:mz_pair_dists ${param_mz_pair_dists}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
20 -algorithm:mz_dev ${param_mz_dev}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
21 #if $adv_opts.adv_opts_selector=='advanced':
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
22 ${adv_opts.param_mrm}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
23 #end if
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
24 </command>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
25 <inputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
26 <param name="param_in" type="data" format="featureXML" optional="False" label="Input file" help="(-in)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
27 <param name="param_rt_estimate" type="boolean" truevalue="-algorithm:rt_estimate true" falsevalue="-algorithm:rt_estimate false" checked="true" optional="True" label="If 'true' the optimal RT pair distance and deviation are estimated by fitting a gaussian distribution to the histogram of pair distance. Note that this works only datasets with a significant amount of pairs! If 'false' the parameters 'rt_pair_dist', 'rt_dev_low' and 'rt_dev_high' define the optimal distance." help="(-rt_estimate)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
28 <param name="param_rt_pair_dist" type="float" value="-20.0" label="optimal pair distance in RT [sec] from light to heavy feature" help="(-rt_pair_dist)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
29 <param name="param_rt_dev_low" type="float" min="0.0" optional="True" value="15.0" label="maximum allowed deviation below optimal retention time distance" help="(-rt_dev_low)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
30 <param name="param_rt_dev_high" type="float" min="0.0" optional="True" value="15.0" label="maximum allowed deviation above optimal retention time distance" help="(-rt_dev_high)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
31 <param name="param_mz_pair_dists" type="text" size="20" value="4.0" label="optimal pair distances in m/z [Th] for features with charge +1 (adapted to +2, +3, .. by division through charge)" help="(-mz_pair_dists)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
32 <param name="param_mz_dev" type="float" min="0.0" optional="True" value="0.05" label="maximum allowed deviation from optimal m/z distance#br#" help="(-mz_dev)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
33 <expand macro="advanced_options">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
34 <param name="param_mrm" type="boolean" truevalue="-algorithm:mrm true" falsevalue="-algorithm:mrm false" checked="false" optional="True" label="this option should be used if the features correspond mrm chromatograms (additionally the precursor is taken into account)" help="(-mrm)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
35 </expand>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
36 </inputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
37 <outputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
38 <data name="param_out" label="Output file" format="consensusXML"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
39 </outputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
40 <help>**What it does**
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
41
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
42 Groups corresponding isotope-labeled features in a feature map.
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
43
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
44
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
45 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_FeatureLinkerLabeled.html
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
46
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
47 @REFERENCES@
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
48 </help>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
49 </tool>