annotate id_mapper.xml @ 2:cf0d72c7b482 draft

Update.
author galaxyp
date Fri, 10 May 2013 17:31:05 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
1 <tool id="openms_id_mapper" version="0.1.0" name="ID Mapper">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
2 <description>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
3 Assigns protein/peptide identifications to features or consensus features.
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 'IDMapper' --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]
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
15 id=$id_input
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
16 in=$type.map_input
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
17 #set $input_type = str($type.input_type)
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
18 #if $input_type == "consensusxml"
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
19 consensusfeature!use_subelements=$type.use_subelements
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
20 #end if
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
21 #if $input_type == "featurexml"
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
22 feature!use_centroid_rt=$type.use_centroid_rt
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
23 feature!use_centroid_mz=$type.use_centroid_mz
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
24 #end if
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
25 out=$map_output
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
26 rt_tolerance=$rt_tolerance
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
27 mz_tolerance=$mz_tolerance
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
28 mz_measure=$mz_measure
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
29 mz_reference=$mz_reference
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
30 ignore_charge=$ignore_charge
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
31 </configfile>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
32 </configfiles>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
33 <inputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
34 <param name="id_input" label="Protein/Peptide Identifications Input" type="data" format="idxml" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
35 <conditional name="type">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
36 <param name="input_type" type="select" label="Map Input Type">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
37 <option value="consensusxml">Consensus</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
38 <option value="featurexml">Feature</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
39 </param>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
40 <when value="consensusxml">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
41 <param format="consensusxml" name="map_input" type="data" label="Input Consensus File"/>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
42 <param name="use_subelements" label="Use Sub-features" help="Match using RT and m/z of sub-features instead of consensus RT and m/z. A consensus feature matches if any of its sub-features matches." truevalue="true" falsevalue="false" type="boolean" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
43 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
44 <when value="featurexml">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
45 <param format="featurexml" name="map_input" type="data" label="Input Feature File"/>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
46 <param name="use_centroid_rt" label="Use Centroid RT" help="Use the RT coordinates of the feature centroids for matching, instead of the RT ranges of the features/mass traces." truevalue="true" falsevalue="false" type="boolean" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
47 <param name="use_centroid_mz" label="Use Centroid m/z" help="Use the m/z coordinates of the feature centroids for matching, instead of the m/z ranges of the features/mass traces. (If you choose 'peptide' as 'mz_reference', you should usually set this flag to avoid false-positive matches.)" truevalue="true" falsevalue="false" type="boolean" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
48 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
49 </conditional>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
50 <param name="rt_tolerance" value="5" label="RT Tolerance (seconds)" type="float" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
51 <param name="mz_tolerance" value="20" label="m/z Tolerance" type="float" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
52 <param name="mz_measure" label="m/z Tolerance Units" type="select">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
53 <option value="ppm">ppm</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
54 <option value="Da">Da</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
55 </param>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
56 <param name="mz_reference" label="m/z Reference" type="select" help="Source of m/z values for peptide identifications. If 'precursor', the precursor-m/z from the idXML is used. If 'peptide', masses are computed from the sequences of peptide hits; in this case, an identification matches if any of its hits matches. ('peptide' should be used together with 'feature:use_centroid_mz' to avoid false-positive matches.)">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
57 <option value="precursor">precursor</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
58 <option value="peptide">peptide</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
59 </param>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
60 <param name="ignore_charge" label="Ignore Charge" help="For feature/consensus maps: Assign an ID independently of whether its charge state matches that of the (consensus) feature." truevalue="true" falsevalue="false" type="boolean" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
61 </inputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
62 <outputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
63 <data format="consensusxml" name="map_output">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
64 <change_format>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
65 <when input="input_type" value="featurexml" format="featurexml" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
66 </change_format>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
67 </data>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
68 </outputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
69 <help>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
70 **What it does**
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
71
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
72 The mapping is based on retention times and mass-to-charge values. Roughly, a peptide identification is assigned to a (consensus) feature if its position lies within the boundaries of the feature or close enough to the feature centroid. Peptide identifications that don't match anywhere are still recorded in the resulting map, as "unassigned peptides". Protein identifications are annotated to the whole map, i.e. not to any particular (consensus) feature.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
73
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
74 In all cases, tolerance in RT and m/z dimension is applied according to the parameters rt_tolerance and mz_tolerance. Tolerance is understood as "plus or minus x", so the matching range is actually increased by twice the tolerance value.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
75
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
76 If several features or consensus features overlap the position of a peptide identification (taking the allowed tolerances into account), the identification is annotated to all of them.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
77
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
78 Annotation of feature maps (featureXML input):
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
79 If all features have at least one convex hull, peptide positions are matched against the bounding boxes of the convex hulls (of individual mass traces, if available) by default. If not, the positions of the feature centroids are used. The respective coordinates of the centroids are also used for matching (in place of the corresponding ranges from the bounding boxes) if feature:use_centroid_rt or feature:use_centroid_mz are true.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
80
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
81 Annotation of consensus maps (consensusXML input):
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
82 Peptide positions are always matched against centroid positions. By default, the consensus centroids are used. However, if consensusfeature:use_subelements is set, the centroids of sub-features are considered instead. In this case, a peptide identification is mapped to a consensus feature if any of its sub-features matches.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
83
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
84 **Citation**
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
85
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
86 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
87
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
88 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
89 </help>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
90 </tool>