annotate ConsensusID.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="ConsensusID" name="ConsensusID" version="2.0.0">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
3 <description>Computes a consensus identification from peptide identifications of several identification engines.</description>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
4 <macros>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">ConsensusID</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>ConsensusID
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
11
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
12 #if $param_in:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
13 -in $param_in
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
14 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
15 #if $param_out:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
16 -out $param_out
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
17 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
18 #if $param_rt_delta:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
19 -rt_delta $param_rt_delta
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
20 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
21 #if $param_mz_delta:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
22 -mz_delta $param_mz_delta
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
23 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
24 #if $param_min_length:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
25 -min_length $param_min_length
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
26 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
27 #if $param_use_all_hits:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
28 -use_all_hits
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
29 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
30 -threads \${GALAXY_SLOTS:-24}
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
31 #if $param_algorithm_algorithm:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
32 -algorithm:algorithm
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
33 #if " " in str($param_algorithm_algorithm):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
34 "$param_algorithm_algorithm"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
35 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
36 $param_algorithm_algorithm
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
37 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
38 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
39 #if $param_algorithm_considered_hits:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
40 -algorithm:considered_hits $param_algorithm_considered_hits
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
41 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
42 #if $param_algorithm_number_of_runs:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
43 -algorithm:number_of_runs $param_algorithm_number_of_runs
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
44 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
45 #if $param_algorithm_PEPIons_MinNumberOfFragments:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
46 -algorithm:PEPIons:MinNumberOfFragments $param_algorithm_PEPIons_MinNumberOfFragments
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
47 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
48 #if $param_algorithm_PEPIons_common:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
49 -algorithm:PEPIons:common $param_algorithm_PEPIons_common
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
50 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
51 #if $param_algorithm_PEPMatrix_common:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
52 -algorithm:PEPMatrix:common $param_algorithm_PEPMatrix_common
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
53 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
54 #if $param_algorithm_PEPMatrix_penalty:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
55 -algorithm:PEPMatrix:penalty $param_algorithm_PEPMatrix_penalty
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
56 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
57 #if $adv_opts.adv_opts_selector=='advanced':
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
58 #if $adv_opts.param_force:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
59 -force
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
60 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
61 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
62 </command>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
63 <inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
64 <param name="param_in" type="data" format="featurexml,consensusxml,idxml" optional="False" label="input file" help="(-in) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
65 <param name="param_rt_delta" type="float" min="0.0" optional="True" value="0.1" label="Maximum allowed precursor RT deviation between identifications" help="(-rt_delta) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
66 <param name="param_mz_delta" type="float" min="0.0" optional="True" value="0.1" label="Maximum allowed precursor m/z deviation between identifications" help="(-mz_delta) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
67 <param name="param_min_length" type="integer" min="1" optional="True" value="6" label="Minimum of length of peptides for final consensus list" help="(-min_length) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
68 <param name="param_use_all_hits" type="boolean" truevalue="-use_all_hits" falsevalue="" checked="false" optional="True" label="If 'true' not only the first hit, but all are used (peptides only)" help="(-use_all_hits) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
69 <param name="param_algorithm_algorithm" type="select" optional="True" value="PEPMatrix" label="Algorithm used for the consensus scoring" help="(-algorithm) &lt;br&gt;ranked -- reorders the hits according to a consensus score computed from the ranks in the input runs. The score is normalized to the interval (0,100). The PeptideIdentifications do not need to have the same score type. &lt;br&gt;average -- reorders the hits according to the average score of the input runs. Make sure to use PeptideIdentifications with the same score type only! &lt;br&gt;PEPMatrix -- calculates a consensus score based on posterior error probabilities and scoring matrices for siimilarity. This algorithm uses the PAM30MS matrix to score sequences not listed by all engines. Make sure to use PeptideIdentifications with score types converted to PEPs only! &lt;br&gt;PEPIons -- calculates a consensus score based on posterior error probabilities and fragment ion siimilarity. Make sure to use PeptideIdentifications with score types converted to PEPs only! &lt;br&gt;Minimum -- calculates a consensus score based on the minimal score. Make sure to use PeptideIdentifications with score types converted to PEPs only! &lt;br&gt;">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
70 <option value="ranked">ranked</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
71 <option value="average">average</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
72 <option value="PEPMatrix">PEPMatrix</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
73 <option value="PEPIons">PEPIons</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
74 <option value="Minimum">Minimum</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
75 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
76 <param name="param_algorithm_considered_hits" type="integer" min="1" optional="True" value="10" label="The number of top hits that are used for the consensus scoring" help="(-considered_hits) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
77 <param name="param_algorithm_number_of_runs" type="integer" min="0" optional="True" value="0" label="The number of runs used as input" help="(-number_of_runs) This information is used in 'Ranked' and 'Average' to compute the new scores. If not given, the number of input identifications is taken"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
78 <param name="param_algorithm_PEPIons_MinNumberOfFragments" type="integer" min="0" optional="True" value="2" label="The minimal number of similar (between two suggested sequences) fragment ion masses that is necessary to evaluate the shared peak count similarity (SPC)" help="(-MinNumberOfFragments) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
79 <param name="param_algorithm_PEPIons_common" type="float" min="0.0" max="1.1" optional="True" value="1.1" label="Similarity threshold to accept the best score" help="(-common) E.g. for a given spectrum: engine 1 -&gt; pep 1 with score x1 and engine2 -&gt; pep2 with score x2. The better score from {x1,x2} will be used if the degree of similarity between pep1 and pep2 &gt;= common, Note that 0 &lt;= degree of similarity &lt;= 1. Values &gt; 1 will disable this option"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
80 <param name="param_algorithm_PEPMatrix_common" type="float" min="0.0" max="1.1" optional="True" value="1.1" label="Similarity threshold to accept the best score" help="(-common) E.g. for a given spectrum: engine 1 -&gt; pep 1 with score x1 and engine2 -&gt; pep2 with score x2. The better score from {x1,x2} will be used if the degree of similarity between pep1 and pep2 &gt;= common, Note that 0 &lt;= degree of similarity &lt;= 1. Values &gt; 1 will disable this option"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
81 <param name="param_algorithm_PEPMatrix_penalty" type="integer" value="5" label="Give the gap penalty (the same penalty will be used for opening and extension) as a positive intege" help="(-penalty) "/>
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 </expand>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
85 </inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
86 <outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
87 <data name="param_out" metadata_source="param_in" format="input"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
88 </outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
89 <help>**What it does**
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
90
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
91 Computes a consensus identification from peptide identifications of several identification engines.
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
92
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
93
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
94 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_ConsensusID.html</help>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
95 <expand macro="references"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
96 </tool>