annotate IDMapper.xml @ 2:9710f8e387d4 draft

Uploaded
author bgruening
date Thu, 16 Apr 2015 09:02:40 -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="IDMapper" name="IDMapper" version="2.0.0">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
3 <description>Assigns protein/peptide identifications to features or consensus features.</description>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
4 <macros>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">IDMapper</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>IDMapper
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
11
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
12 #if $param_id:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
13 -id $param_id
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
14 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
15 #if $param_in:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
16 -in $param_in
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
17 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
18 #if $param_out:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
19 -out $param_out
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
20 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
21 #if $param_rt_tolerance:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
22 -rt_tolerance $param_rt_tolerance
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
23 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
24 #if $param_mz_tolerance:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
25 -mz_tolerance $param_mz_tolerance
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
26 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
27 #if $param_mz_measure:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
28 -mz_measure
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
29 #if " " in str($param_mz_measure):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
30 "$param_mz_measure"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
31 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
32 $param_mz_measure
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
33 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
34 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
35 #if $param_mz_reference:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
36 -mz_reference
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
37 #if " " in str($param_mz_reference):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
38 "$param_mz_reference"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
39 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
40 $param_mz_reference
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
41 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
42 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
43 #if $param_ignore_charge:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
44 -ignore_charge
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
45 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
46 -threads \${GALAXY_SLOTS:-24}
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
47 #if $param_feature_use_centroid_rt:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
48 -feature:use_centroid_rt
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
49 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
50 #if $param_feature_use_centroid_mz:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
51 -feature:use_centroid_mz
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
52 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
53 #if $param_consensus_use_subelements:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
54 -consensus:use_subelements
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
55 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
56 #if $adv_opts.adv_opts_selector=='advanced':
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
57 #if $adv_opts.param_force:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
58 -force
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
59 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
60 #if $adv_opts.param_consensus_annotate_ids_with_subelements:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
61 -consensus:annotate_ids_with_subelements
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
62 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
63 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
64 </command>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
65 <inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
66 <param name="param_id" type="data" format="idxml" optional="False" label="Protein/peptide identifications file" help="(-id) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
67 <param name="param_in" type="data" format="featurexml,consensusxml,mzq" optional="False" label="Feature map/consensus map file" help="(-in) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
68 <param name="param_rt_tolerance" type="float" min="0.0" optional="True" value="5.0" label="RT tolerance (in seconds) for the matching of peptide identifications and (consensus) features" help="(-rt_tolerance) &lt;br&gt;Tolerance is understood as 'plus or minus x', so the matching range increases by twice the given value"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
69 <param name="param_mz_tolerance" type="float" min="0.0" optional="True" value="20.0" label="m/z tolerance (in ppm or Da) for the matching of peptide identifications and (consensus) features" help="(-mz_tolerance) &lt;br&gt;Tolerance is understood as 'plus or minus x', so the matching range increases by twice the given value"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
70 <param name="param_mz_measure" type="select" optional="True" value="ppm" label="Unit of 'mz_tolerance'" help="(-mz_measure) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
71 <option value="ppm">ppm</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
72 <option value="Da">Da</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
73 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
74 <param name="param_mz_reference" type="select" optional="True" value="precursor" label="Source of m/z values for peptide identifications" help="(-mz_reference) If 'precursor', the precursor-m/z from the idXML is used. If 'peptide', &lt;br&gt;masses are computed from the sequences of peptide hits; in this case, an identification matches if any of its hits matches. &lt;br&gt;('peptide' should be used together with 'feature:use_centroid_mz' to avoid false-positive matches.)">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
75 <option value="precursor">precursor</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
76 <option value="peptide">peptide</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
77 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
78 <param name="param_ignore_charge" type="boolean" truevalue="-ignore_charge" falsevalue="" checked="false" optional="True" label="For feature/consensus maps: Assign an ID independently of whether its charge state matches that of the (consensus) feature" help="(-ignore_charge) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
79 <param name="param_feature_use_centroid_rt" type="boolean" truevalue="-feature:use_centroid_rt" falsevalue="" checked="false" optional="True" label="Use the RT coordinates of the feature centroids for matching, instead of the RT ranges of the features/mass traces" help="(-use_centroid_rt) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
80 <param name="param_feature_use_centroid_mz" type="boolean" truevalue="-feature:use_centroid_mz" falsevalue="" checked="false" optional="True" label="Use the m/z coordinates of the feature centroids for matching, instead of the m/z ranges of the features/mass traces" help="(-use_centroid_mz) &lt;br&gt;(If you choose 'peptide' as 'mz_reference', you should usually set this flag to avoid false-positive matches.)"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
81 <param name="param_consensus_use_subelements" type="boolean" truevalue="-consensus:use_subelements" falsevalue="" checked="false" optional="True" label="Match using RT and m/z of sub-features instead of consensus RT and m/z" help="(-use_subelements) A consensus feature matches if any of its sub-features matches"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
82 <expand macro="advanced_options">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
83 <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
84 <param name="param_consensus_annotate_ids_with_subelements" type="boolean" truevalue="-consensus:annotate_ids_with_subelements" falsevalue="" checked="false" optional="True" label="Store the map index of the sub-feature in the peptide ID" help="(-annotate_ids_with_subelements) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
85 </expand>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
86 </inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
87 <outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
88 <data name="param_out" metadata_source="param_in" format="input"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
89 </outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
90 <help>**What it does**
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
91
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
92 Assigns protein/peptide identifications to features or consensus features.
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
93
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
94
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
95 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_IDMapper.html</help>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
96 <expand macro="references"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
97 </tool>