annotate feature_linker_unlabeled.xml @ 4:1183846e70a1 draft

Uploaded
author galaxyp
date Wed, 19 Jun 2013 13:15:44 -0400
parents cf0d72c7b482
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
1 <tool id="openms_feature_linker_unlabeled" version="0.1.0" name="Feature Linker (Unlabeled)">
2
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
2 <description>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
3 Groups corresponding features from multiple maps.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
4 </description>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
5 <macros>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
6 <import>macros.xml</import>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
7 </macros>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
8 <expand macro="stdio" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
9 <expand macro="requires" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
10 <command interpreter="python">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
11 openms_wrapper.py --executable 'FeatureLinkedUnlabeled' --config $config
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
12 </command>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
13 <configfiles>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
14 <configfile name="config">[simple_options]
4
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
15 in=${",".join(map(str, $inputs))}
2
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
16 out=$output
4
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
17 #if $type.input_type == "consensusxml"
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
18 $keep_subelements
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
19 #end if
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
20 $ignore_charge
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
21 $use_identifications
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
22 algorithm!second_nearest_gap=$second_nearest_gap
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
23 algorithm!distance_RT!max_difference=$rt_max_difference
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
24 algorithm!distance_MZ!max_difference=$mz_max_difference
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
25 algorithm!distance_MZ!unit=$mz_max_difference_unit
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
26 #if $advanced.specify
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
27 algorithm!distance_RT!weight=$advanced.rt_weight
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
28 algorithm!distance_MZ!weight=$advanced.mz_weight
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
29 algorithm!distance_intensity!weight=$advanced.intensity_weight
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
30 algorithm!distance_RT!exponent=$advanced.rt_exponent
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
31 algorithm!distance_MZ!exponent=$advanced.mz_exponent
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
32 algorithm!distance_intensity!exponent=$advanced.intensity_exponent
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
33 #end if
2
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
34 </configfile>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
35 </configfiles>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
36 <inputs>
4
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
37 <expand macro="feature_linker_input" />
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
38 <param name="second_nearest_gap" value="2" type="integer" label="Second Nearest Gap" help="The distance to the second nearest neighbors must be larger by this factor than the distance to the matching element itself." />
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
39 <expand macro="feature_linker_algorithm_options" />
2
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
40 </inputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
41 <outputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
42 <data format="consensusxml" name="output" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
43 </outputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
44 <help>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
45 **What it does**
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
46
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
47 This tool provides an algorithm for grouping corresponding features in multiple runs of label-free experiments. For more details and algorithm-specific parameters (set in the INI file) see "Detailed Description" in the algorithm documentation or the INI file table below.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
48
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
49 FeatureLinkerUnlabeled takes several feature maps (featureXML files) and stores the corresponding features in a consensus map (consensusXML file). Feature maps can be created from MS experiments (peak data) using one of the FeatureFinder TOPP tools.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
50
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
51 Advanced users can convert the consensusXML generated by this tool to EDTA using FileConverter and plot the distribution of distances in RT (or m/z) between different input files (can be done in Excel). The distribution should be Gaussian-like with very few points beyond the tails. Points far away from the Gaussian indicate a too wide tolerance. A Gaussian with its left/right tail trimmed indicates a too narrow tolerance.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
52
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
53 **Citation**
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
54
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
55 For the underlying tool, please cite ``Marc Sturm, Andreas Bertsch, Clemens Gröpl, Andreas Hildebrandt, Rene Hussong, Eva Lange, Nico Pfeifer, Ole Schulz-Trieglaff, Alexandra Zerck, Knut Reinert, and Oliver Kohlbacher, 2008. OpenMS – an Open-Source Software Framework for Mass Spectrometry. BMC Bioinformatics 9: 163. doi:10.1186/1471-2105-9-163.``
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
56
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
57 If you use this tool in Galaxy, please cite Chilton J, et al. https://bitbucket.org/galaxyp/galaxyp-toolshed-openms
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
58 </help>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
59 </tool>