annotate PeptideIndexer.xml @ 0:539a3a4dcc9e draft

planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8

<?xml version='1.0' encoding='UTF-8'?>
<!--This is a configuration file for the integration of a tools into Galaxy (https://galaxyproject.org/). This file was automatically generated using CTD2Galaxy.-->
<!--Proposed Tool Section: [ID Processing]-->
<tool id="PeptideIndexer" name="PeptideIndexer" version="2.1.0">
  <description>Refreshes the protein references for all peptide hits.</description>
  <macros>
    <token name="@EXECUTABLE@">PeptideIndexer</token>
    <import>macros.xml</import>
  </macros>
  <expand macro="references"/>
  <expand macro="stdio"/>
  <expand macro="requirements"/>
  <command>PeptideIndexer

#if $param_in:
  -in $param_in
#end if
#if $param_fasta:
  -fasta $param_fasta
#end if
#if $param_out:
  -out $param_out
#end if
#if $param_decoy_string:
  -decoy_string     "$param_decoy_string"
#end if
#if $param_decoy_string_position:
  -decoy_string_position $param_decoy_string_position
#end if
#if $param_missing_decoy_action:
  -missing_decoy_action $param_missing_decoy_action
#end if
#if $param_write_protein_sequence:
  -write_protein_sequence
#end if
#if $param_write_protein_description:
  -write_protein_description
#end if
#if $param_keep_unreferenced_proteins:
  -keep_unreferenced_proteins
#end if
#if $param_allow_unmatched:
  -allow_unmatched
#end if
#if $param_full_tolerant_search:
  -full_tolerant_search
#end if
#if $param_aaa_max:
  -aaa_max $param_aaa_max
#end if
#if $param_mismatches_max:
  -mismatches_max $param_mismatches_max
#end if
#if $param_IL_equivalent:
  -IL_equivalent
#end if
#if $param_filter_aaa_proteins:
  -filter_aaa_proteins
#end if
#if $param_enzyme_name:
  -enzyme:name $param_enzyme_name
#end if
#if $param_enzyme_specificity:
  -enzyme:specificity $param_enzyme_specificity
#end if
#if $adv_opts.adv_opts_selector=='advanced':
    #if $adv_opts.param_force:
  -force
#end if
#end if
</command>
  <inputs>
    <param name="param_in" type="data" format="idxml" optional="False" label="Input idXML file containing the identifications" help="(-in) "/>
    <param name="param_fasta" type="data" format="fasta" optional="False" label="Input sequence database in FASTA format" help="(-fasta) Non-existing relative filenames are looked up via 'OpenMS.ini:id_db_dir'"/>
    <param name="param_decoy_string" type="text" size="30" value="DECOY_" label="String that was appended (or prefixed - see 'decoy_string_position' flag below) to the accessions in the protein database to indicate decoy proteins" help="(-decoy_string) ">
      <sanitizer>
        <valid initial="string.printable">
          <remove value="'"/>
          <remove value="&quot;"/>
        </valid>
      </sanitizer>
    </param>
    <param name="param_decoy_string_position" display="radio" type="select" optional="False" value="prefix" label="Should the 'decoy_string' be prepended (prefix) or appended (suffix) to the protein accession?" help="(-decoy_string_position) ">
      <option value="prefix" selected="true">prefix</option>
      <option value="suffix">suffix</option>
    </param>
    <param name="param_missing_decoy_action" display="radio" type="select" optional="False" value="error" label="Action to take if NO peptide was assigned to a decoy protein (which indicates wrong database or decoy string): 'error' (exit with error, no output), 'warn' (exit with success, warning message)" help="(-missing_decoy_action) ">
      <option value="error" selected="true">error</option>
      <option value="warn">warn</option>
    </param>
    <param name="param_write_protein_sequence" display="radio" type="boolean" truevalue="-write_protein_sequence" falsevalue="" checked="false" optional="True" label="If set, the protein sequences are stored as well" help="(-write_protein_sequence) "/>
    <param name="param_write_protein_description" display="radio" type="boolean" truevalue="-write_protein_description" falsevalue="" checked="false" optional="True" label="If set, the protein description is stored as well" help="(-write_protein_description) "/>
    <param name="param_keep_unreferenced_proteins" display="radio" type="boolean" truevalue="-keep_unreferenced_proteins" falsevalue="" checked="false" optional="True" label="If set, protein hits which are not referenced by any peptide are kept" help="(-keep_unreferenced_proteins) "/>
    <param name="param_allow_unmatched" display="radio" type="boolean" truevalue="-allow_unmatched" falsevalue="" checked="false" optional="True" label="If set, unmatched peptide sequences are allowed" help="(-allow_unmatched) By default (i.e. if this flag is not set) the program terminates with an error on unmatched peptides"/>
    <param name="param_full_tolerant_search" display="radio" type="boolean" truevalue="-full_tolerant_search" falsevalue="" checked="false" optional="True" label="If set, all peptide sequences are matched using tolerant search" help="(-full_tolerant_search) Thus potentially more proteins (containing ambiguous amino acids) are associated. This is much slower!"/>
    <param name="param_aaa_max" type="integer" min="0" optional="True" value="4" label="[tolerant search only] Maximal number of ambiguous amino acids (AAAs) allowed when matching to a protein database with AAAs" help="(-aaa_max) AAAs are 'B', 'Z' and 'X'"/>
    <param name="param_mismatches_max" type="integer" min="0" optional="True" value="0" label="[tolerant search only] Maximal number of real mismatches (will be used after checking for ambiguous AA's (see 'aaa_max' option)" help="(-mismatches_max) In general this param should only be changed if you want to look for other potential origins of a peptide which might have unknown SNPs or the like"/>
    <param name="param_IL_equivalent" display="radio" type="boolean" truevalue="-IL_equivalent" falsevalue="" checked="false" optional="True" label="Treat the isobaric amino acids isoleucine ('I') and leucine ('L') as equivalent (indistinguishable)" help="(-IL_equivalent) "/>
    <param name="param_filter_aaa_proteins" display="radio" type="boolean" truevalue="-filter_aaa_proteins" falsevalue="" checked="false" optional="True" label="In the tolerant search for matches to proteins with ambiguous amino acids (AAAs), rebuild the search database to only consider proteins with AAAs" help="(-filter_aaa_proteins) This may save time if most proteins don't contain AAAs and if there is a significant number of peptides that enter the tolerant search"/>
    <param name="param_enzyme_name" type="select" optional="False" value="Trypsin" label="Enzyme which determines valid cleavage sites -" help="(-name) e.g. trypsin cleaves after lysine (K) or arginine (R), but not before proline (P)">
      <option value="Lys-C/P">Lys-C/P</option>
      <option value="unspecific cleavage">unspecific cleavage</option>
      <option value="Lys-C">Lys-C</option>
      <option value="Formic_acid">Formic_acid</option>
      <option value="Trypsin" selected="true">Trypsin</option>
      <option value="V8-DE">V8-DE</option>
      <option value="2-iodobenzoate">2-iodobenzoate</option>
      <option value="Asp-N_ambic">Asp-N_ambic</option>
      <option value="no cleavage">no cleavage</option>
      <option value="V8-E">V8-E</option>
      <option value="leukocyte elastase">leukocyte elastase</option>
      <option value="CNBr">CNBr</option>
      <option value="glutamyl endopeptidase">glutamyl endopeptidase</option>
      <option value="TrypChymo">TrypChymo</option>
      <option value="PepsinA">PepsinA</option>
      <option value="Asp-N">Asp-N</option>
      <option value="Arg-C">Arg-C</option>
      <option value="proline endopeptidase">proline endopeptidase</option>
      <option value="Chymotrypsin">Chymotrypsin</option>
      <option value="Trypsin/P">Trypsin/P</option>
    </param>
    <param name="param_enzyme_specificity" display="radio" type="select" optional="False" value="full" label="Specificity of the enzyme" help="(-specificity) &lt;br&gt;  'full': both internal cleavage sites must match. &lt;br&gt;  'semi': one of two internal cleavage sites must match. &lt;br&gt;  'none': allow all peptide hits no matter their context. Therefore, the enzyme chosen does not play a role here">
      <option value="full" selected="true">full</option>
      <option value="semi">semi</option>
      <option value="none">none</option>
    </param>
    <expand macro="advanced_options">
      <param name="param_force" display="radio" type="boolean" truevalue="-force" falsevalue="" checked="false" optional="True" label="Overwrite tool specific checks" help="(-force) "/>
    </expand>
  </inputs>
  <outputs>
    <data name="param_out" format="idxml"/>
  </outputs>
  <help>Refreshes the protein references for all peptide hits.


For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_PeptideIndexer.html</help>
</tool>