annotate PeptideIndexer.xml @ 9:c4a73c6a8dca draft

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

<?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 CTDConverter.-->
<!--Proposed Tool Section: [ID Processing]-->
<tool id="PeptideIndexer" name="PeptideIndexer" version="@TOOL_VERSION@+galaxy@GALAXY_VERSION@" profile="20.05">
  <description>Refreshes the protein references for all peptide hits.</description>
  <macros>
    <token name="@EXECUTABLE@">PeptideIndexer</token>
    <import>macros.xml</import>
    <import>macros_autotest.xml</import>
    <import>macros_test.xml</import>
  </macros>
  <expand macro="requirements"/>
  <expand macro="stdio"/>
  <command detect_errors="exit_code"><![CDATA[@QUOTE_FOO@
@EXT_FOO@
#import re

## Preprocessing
mkdir in &&
ln -s '$in' 'in/${re.sub("[^\w\-_]", "_", $in.element_identifier)}.$gxy2omsext($in.ext)' &&
mkdir fasta &&
ln -s '$fasta' 'fasta/${re.sub("[^\w\-_]", "_", $fasta.element_identifier)}.$gxy2omsext($fasta.ext)' &&
mkdir out &&

## Main program call

set -o pipefail &&
@EXECUTABLE@ -write_ctd ./ &&
python3 '$__tool_directory__/fill_ctd.py' '@EXECUTABLE@.ctd' '$args_json' '$hardcoded_json' &&
@EXECUTABLE@ -ini @EXECUTABLE@.ctd
-in
'in/${re.sub("[^\w\-_]", "_", $in.element_identifier)}.$gxy2omsext($in.ext)'
-fasta
'fasta/${re.sub("[^\w\-_]", "_", $fasta.element_identifier)}.$gxy2omsext($fasta.ext)'
-out
'out/output.${gxy2omsext("idxml")}'

## Postprocessing
&& mv 'out/output.${gxy2omsext("idxml")}' '$out'
#if "ctd_out_FLAG" in $OPTIONAL_OUTPUTS
  && mv '@EXECUTABLE@.ctd' '$ctd_out'
#end if]]></command>
  <configfiles>
    <inputs name="args_json" data_style="paths"/>
    <configfile name="hardcoded_json"><![CDATA[{"log": "log.txt", "threads": "\${GALAXY_SLOTS:-1}", "no_progress": true}]]></configfile>
  </configfiles>
  <inputs>
    <param name="in" argument="-in" type="data" format="idxml" optional="false" label="Input idXML file containing the identifications" help=" select idxml data sets(s)"/>
    <param name="fasta" argument="-fasta" type="data" format="fasta" optional="false" label="Input sequence database in FASTA format" help="Non-existing relative filenames are looked up via 'OpenMS.ini:id_db_dir' select fasta data sets(s)"/>
    <param name="decoy_string" argument="-decoy_string" type="text" optional="true" value="" 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="If empty (default), it's determined automatically (checking for common terms, both as prefix and suffix)">
      <expand macro="list_string_san"/>
    </param>
    <param name="decoy_string_position" argument="-decoy_string_position" display="radio" type="select" optional="false" label="Is the 'decoy_string' prepended (prefix) or appended (suffix) to the protein accession" help="(ignored if decoy_string is empty)">
      <option value="prefix" selected="true">prefix</option>
      <option value="suffix">suffix</option>
      <expand macro="list_string_san"/>
    </param>
    <param name="missing_decoy_action" argument="-missing_decoy_action" display="radio" type="select" optional="false" 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), 'silent' (no action is taken, not even a warning)" help="">
      <option value="error" selected="true">error</option>
      <option value="warn">warn</option>
      <option value="silent">silent</option>
      <expand macro="list_string_san"/>
    </param>
    <param name="write_protein_sequence" argument="-write_protein_sequence" type="boolean" truevalue="true" falsevalue="false" checked="false" label="If set, the protein sequences are stored as well" help=""/>
    <param name="write_protein_description" argument="-write_protein_description" type="boolean" truevalue="true" falsevalue="false" checked="false" label="If set, the protein description is stored as well" help=""/>
    <param name="keep_unreferenced_proteins" argument="-keep_unreferenced_proteins" type="boolean" truevalue="true" falsevalue="false" checked="false" label="If set, protein hits which are not referenced by any peptide are kept" help=""/>
    <param name="allow_unmatched" argument="-allow_unmatched" type="boolean" truevalue="true" falsevalue="false" checked="false" label="If set, unmatched peptide sequences are allowed" help="By default (i.e. if this flag is not set) the program terminates with an error on unmatched peptides"/>
    <param name="aaa_max" argument="-aaa_max" type="integer" optional="true" min="0" max="10" value="3" label="Maximal number of ambiguous amino acids (AAAs) allowed when matching to a protein database with AAAs" help="AAAs are B, J, Z and X!"/>
    <param name="mismatches_max" argument="-mismatches_max" type="integer" optional="true" min="0" max="10" value="0" label="Maximal number of mismatched (mm) amino acids allowed when matching to a protein database" help="The required runtime is exponential in the number of mm's; apply with care. MM's are allowed in addition to AAA's"/>
    <param name="IL_equivalent" argument="-IL_equivalent" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Treat the isobaric amino acids isoleucine ('I') and leucine ('L') as equivalent (indistinguishable)" help="Also occurences of 'J' will be treated as 'I' thus avoiding ambiguous matching"/>
    <section name="enzyme" title="" help="" expanded="false">
      <param name="name" argument="-enzyme:name" type="select" optional="false" label="Enzyme which determines valid cleavage sites -" help="e.g. trypsin cleaves after lysine (K) or arginine (R), but not before proline (P)">
        <option value="Chymotrypsin">Chymotrypsin</option>
        <option value="Chymotrypsin/P">Chymotrypsin/P</option>
        <option value="CNBr">CNBr</option>
        <option value="Formic_acid">Formic_acid</option>
        <option value="Asp-N">Asp-N</option>
        <option value="Asp-N/B">Asp-N/B</option>
        <option value="Asp-N_ambic">Asp-N_ambic</option>
        <option value="staphylococcal protease/D">staphylococcal protease/D</option>
        <option value="proline-endopeptidase/HKR">proline-endopeptidase/HKR</option>
        <option value="Glu-C+P">Glu-C+P</option>
        <option value="PepsinA + P">PepsinA + P</option>
        <option value="cyanogen-bromide">cyanogen-bromide</option>
        <option value="Clostripain/P">Clostripain/P</option>
        <option value="elastase-trypsin-chymotrypsin">elastase-trypsin-chymotrypsin</option>
        <option value="no cleavage">no cleavage</option>
        <option value="unspecific cleavage">unspecific cleavage</option>
        <option value="TrypChymo">TrypChymo</option>
        <option value="Trypsin/P">Trypsin/P</option>
        <option value="V8-DE">V8-DE</option>
        <option value="V8-E">V8-E</option>
        <option value="leukocyte elastase">leukocyte elastase</option>
        <option value="proline endopeptidase">proline endopeptidase</option>
        <option value="glutamyl endopeptidase">glutamyl endopeptidase</option>
        <option value="Alpha-lytic protease">Alpha-lytic protease</option>
        <option value="2-iodobenzoate">2-iodobenzoate</option>
        <option value="iodosobenzoate">iodosobenzoate</option>
        <option value="Arg-C">Arg-C</option>
        <option value="Arg-C/P">Arg-C/P</option>
        <option value="Lys-C">Lys-C</option>
        <option value="Lys-N">Lys-N</option>
        <option value="Lys-C/P">Lys-C/P</option>
        <option value="PepsinA">PepsinA</option>
        <option value="Trypsin" selected="true">Trypsin</option>
        <expand macro="list_string_san"/>
      </param>
      <param name="specificity" argument="-enzyme:specificity" display="radio" type="select" optional="false" label="Specificity of the enzyme" help="'full': both internal cleavage sites must match..   'semi': one of two internal cleavage sites must match..   '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>
        <expand macro="list_string_san"/>
      </param>
    </section>
    <expand macro="adv_opts_macro">
      <param name="force" argument="-force" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Overwrite tool specific checks" help=""/>
      <param name="test" argument="-test" type="hidden" optional="true" value="False" label="Enables the test mode (needed for internal use only)" help="">
        <expand macro="list_string_san"/>
      </param>
    </expand>
    <param name="OPTIONAL_OUTPUTS" type="select" multiple="true" label="Optional outputs" optional="true">
      <option value="ctd_out_FLAG">Output used ctd (ini) configuration file</option>
    </param>
  </inputs>
  <outputs>
    <data name="out" label="${tool.name} on ${on_string}: out" format="idxml"/>
    <data name="ctd_out" format="xml" label="${tool.name} on ${on_string}: ctd">
      <filter>OPTIONAL_OUTPUTS is not None and "ctd_out_FLAG" in OPTIONAL_OUTPUTS</filter>
    </data>
  </outputs>
  <tests>
    <expand macro="autotest_PeptideIndexer"/>
    <expand macro="manutest_PeptideIndexer"/>
  </tests>
  <help><![CDATA[Refreshes the protein references for all peptide hits.


For more information, visit http://www.openms.de/documentation/TOPP_PeptideIndexer.html]]></help>
  <expand macro="references"/>
</tool>