annotate MassCalculator.xml @ 9:ff18cb79cdd2 draft

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

<?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: [Utilities]-->
<tool id="MassCalculator" name="MassCalculator" version="@TOOL_VERSION@+galaxy@GALAXY_VERSION@" profile="20.05">
  <description>Calculates masses and mass-to-charge ratios of peptide sequences</description>
  <macros>
    <token name="@EXECUTABLE@">MassCalculator</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
#if $in:
  mkdir in &&
  ln -s '$in' 'in/${re.sub("[^\w\-_]", "_", $in.element_identifier)}.$gxy2omsext($in.ext)' &&
#end if
#if "out_FLAG" in str($OPTIONAL_OUTPUTS).split(',')
  mkdir out &&
#end if

## 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
#if $in:
  -in
  'in/${re.sub("[^\w\-_]", "_", $in.element_identifier)}.$gxy2omsext($in.ext)'
#end if
#if "out_FLAG" in str($OPTIONAL_OUTPUTS).split(',')
  -out
  'out/output.${gxy2omsext("txt")}'
#end if
#if len(str($OPTIONAL_OUTPUTS).split(',')) == 0
  | tee '$stdout'
#end if

## Postprocessing
#if "out_FLAG" in str($OPTIONAL_OUTPUTS).split(',')
  && mv 'out/output.${gxy2omsext("txt")}' '$out'
#end if
#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="txt" optional="true" label="Input file with peptide sequences and optionally charge numbers (mutually exclusive to 'in_seq')" help=" select txt data sets(s)"/>
    <param name="in_seq" argument="-in_seq" type="text" optional="true" value="" label="List of peptide sequences (mutually exclusive to 'in')" help=" (space separated list, in order to allow for spaces in list items surround them by single quotes)">
      <expand macro="list_string_val"/>
      <expand macro="list_string_san"/>
    </param>
    <param name="charge" argument="-charge" type="text" optional="true" value="0" label="List of charge states; required if 'in_seq' is given" help=" (space separated list, in order to allow for spaces in list items surround them by single quotes)">
      <expand macro="list_integer_valsan"/>
    </param>
    <param name="format" argument="-format" display="radio" type="select" optional="false" label="Output format ('list': human-readable list, 'table': CSV-like table, 'mass_only': mass values only, 'mz_only': m/z values only)" help="">
      <option value="list" selected="true">list</option>
      <option value="table">table</option>
      <option value="mass_only">mass_only</option>
      <option value="mz_only">mz_only</option>
      <expand macro="list_string_san"/>
    </param>
    <param name="average_mass" argument="-average_mass" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Compute average (instead of monoisotopic) peptide masses" help=""/>
    <param name="fragment_type" argument="-fragment_type" type="select" optional="false" label="For what type of sequence/fragment the mass should be computed" help="">
      <option value="full" selected="true">full</option>
      <option value="internal">internal</option>
      <option value="N-terminal">N-terminal</option>
      <option value="C-terminal">C-terminal</option>
      <option value="a-ion">a-ion</option>
      <option value="b-ion">b-ion</option>
      <option value="c-ion">c-ion</option>
      <option value="x-ion">x-ion</option>
      <option value="y-ion">y-ion</option>
      <option value="z-ion">z-ion</option>
      <expand macro="list_string_san"/>
    </param>
    <param name="separator" argument="-separator" type="text" optional="true" value="" label="Field separator for 'table' output format; by default, the 'tab' character is used" help="">
      <expand macro="list_string_san"/>
    </param>
    <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="false">
      <option value="out_FLAG">out (Enables the test mode (needed for internal use only))</option>
      <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="txt">
      <filter>OPTIONAL_OUTPUTS is not None and "out_FLAG" in OPTIONAL_OUTPUTS</filter>
    </data>
    <data name="stdout" format="txt" label="${tool.name} on ${on_string}: stdout">
      <filter>OPTIONAL_OUTPUTS is None</filter>
    </data>
    <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_MassCalculator"/>
    <expand macro="manutest_MassCalculator"/>
  </tests>
  <help><![CDATA[Calculates masses and mass-to-charge ratios of peptide sequences


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