view ConsensusID.xml @ 3:ec62782f6c68 draft

Uploaded
author bgruening
date Mon, 13 Oct 2014 10:18:22 -0400
parents 3d84209d3178
children 6ead64a594bd
line wrap: on
line source

<?xml version='1.0' encoding='UTF-8'?>
<tool id="ConsensusID" name="ConsensusID" version="1.12.0">
  <description>Computes a consensus identification from peptide identifications of several identification engines.</description>
  <macros>
    <token name="@EXECUTABLE@">ConsensusID</token>
    <import>macros.xml</import>
  </macros>
  <expand macro="stdio"/>
  <expand macro="requirements"/>
  <command>ConsensusID

-in ${param_in}
-out ${param_out}
-rt_delta ${param_rt_delta}
-mz_delta ${param_mz_delta}
-min_length ${param_min_length}
${param_use_all_hits}
-threads \${GALAXY_SLOTS:-24} 
-algorithm:algorithm ${param_algorithm}
-algorithm:considered_hits ${param_considered_hits}
-algorithm:number_of_runs ${param_number_of_runs}
-algorithm:PEPIons:MinNumberOfFragments ${param_MinNumberOfFragments}
-algorithm:PEPIons:common ${param_common}
-algorithm:PEPMatrix:common ${param_common}
-algorithm:PEPMatrix:penalty ${param_penalty}
</command>
  <inputs>
    <param name="param_in" type="data" format="idXML,featureXML,consensusXML" optional="False" label="input file" help="(-in)"/>
    <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)"/>
    <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)"/>
    <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)"/>
    <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)"/>
    <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)">
      <option value="ranked">ranked</option>
      <option value="average">average</option>
      <option value="PEPMatrix">PEPMatrix</option>
      <option value="PEPIons">PEPIons</option>
      <option value="Minimum">Minimum</option>
    </param>
    <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)"/>
    <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)"/>
    <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)"/>
    <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)"/>
    <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)"/>
    <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)"/>
  </inputs>
  <outputs>
    <data name="param_out" label="output file" format="consensusXML">
      <change_format>
        <when input="param_out_type" value="idXML" format="idXML"/>
        <when input="param_out_type" value="featureXML" format="featureXML"/>
      </change_format>
    </data>
  </outputs>
  <help>**What it does**

Computes a consensus identification from peptide identifications of several identification engines.


For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_ConsensusID.html

@REFERENCES@
</help>
</tool>