annotate ConsensusID.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="ConsensusID" name="ConsensusID" version="1.12.0">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
3 <description>Computes a consensus identification from peptide identifications of several identification engines.</description>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
4 <macros>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">ConsensusID</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>ConsensusID
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 -rt_delta ${param_rt_delta}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
15 -mz_delta ${param_mz_delta}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
16 -min_length ${param_min_length}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
17 ${param_use_all_hits}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
18 -threads \${GALAXY_SLOTS:-24}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
19 -algorithm:algorithm ${param_algorithm}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
20 -algorithm:considered_hits ${param_considered_hits}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
21 -algorithm:number_of_runs ${param_number_of_runs}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
22 -algorithm:PEPIons:MinNumberOfFragments ${param_MinNumberOfFragments}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
23 -algorithm:PEPIons:common ${param_common}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
24 -algorithm:PEPMatrix:common ${param_common}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
25 -algorithm:PEPMatrix:penalty ${param_penalty}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
26 </command>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
27 <inputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
28 <param name="param_in" type="data" format="idXML,featureXML,consensusXML" optional="False" label="input file" help="(-in)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
29 <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)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
30 <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)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
31 <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)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
32 <param name="param_use_all_hits" type="boolean" truevalue="-use_all_hits true" falsevalue="-use_all_hits false" checked="false" optional="True" label="If 'true' not only the first hit, but all are used (peptides only)" help="(-use_all_hits)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
33 <param name="param_algorithm" type="select" optional="True" value="PEPMatrix" label="Algorithm used for the consensus scoring.#br#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.#br#average -- reorders the hits according to the average score of the input runs. Make sure to use PeptideIdentifications with the same score type only!#br#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!#br#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!#br#Minimum -- calculates a consensus score based on the minimal score. Make sure to use PeptideIdentifications with score types converted to PEPs only!#br#" help="(-algorithm)">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
34 <option value="ranked">ranked</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
35 <option value="average">average</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
36 <option value="PEPMatrix">PEPMatrix</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
37 <option value="PEPIons">PEPIons</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
38 <option value="Minimum">Minimum</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
39 </param>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
40 <param name="param_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)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
41 <param name="param_number_of_runs" type="integer" min="0" optional="True" value="0" label="The number of runs used as input. This information is used in 'Ranked' and 'Average' to compute the new scores. If not given, the number of input identifications is taken." help="(-number_of_runs)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
42 <param name="param_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)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
43 <param name="param_common" type="float" min="0.0" max="1.1" optional="True" value="1.1" label="Similarity threshold to accept the best score. 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." help="(-common)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
44 <param name="param_common" type="float" min="0.0" max="1.1" optional="True" value="1.1" label="Similarity threshold to accept the best score. 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." help="(-common)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
45 <param name="param_penalty" type="integer" value="5" label="Give the gap penalty (the same penalty will be used for opening and extension) as a positive integer" help="(-penalty)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
46 </inputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
47 <outputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
48 <data name="param_out" label="output file" format="consensusXML">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
49 <change_format>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
50 <when input="param_out_type" value="idXML" format="idXML"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
51 <when input="param_out_type" value="featureXML" format="featureXML"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
52 </change_format>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
53 </data>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
54 </outputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
55 <help>**What it does**
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
56
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
57 Computes a consensus identification from peptide identifications of several identification engines.
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
58
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
59
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
60 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_ConsensusID.html
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
61
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
62 @REFERENCES@
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
63 </help>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
64 </tool>