annotate NoiseFilterSGolay.xml @ 14:35468667de97 draft default tip

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

<!--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: [Spectrum processing: peak smoothing / normalization]-->
<tool id="NoiseFilterSGolay" name="NoiseFilterSGolay" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="21.05">
  <description>Removes noise from profile spectra by using a Savitzky Golay filter. Requires uniform (equidistant) data</description>
  <macros>
    <token name="@EXECUTABLE@">NoiseFilterSGolay</token>
    <import>macros.xml</import>
  </macros>
  <expand macro="requirements"/>
  <expand macro="stdio"/>
  <command detect_errors="exit_code"><![CDATA[@QUOTE_FOO@
@EXT_FOO@
#import re

## Preprocessing
mkdir in &&
cp '$in' 'in/${re.sub("[^\w\-_]", "_", $in.element_identifier)}.$gxy2omsext($in.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)'
-out
'out/output.${gxy2omsext("mzml")}'

## Postprocessing
&& mv 'out/output.${gxy2omsext("mzml")}' '$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 argument="-in" type="data" format="mzml" label="input raw data file" help=" select mzml data sets(s)"/>
    <section name="algorithm" title="Algorithm parameters section" help="" expanded="false">
      <param name="frame_length" argument="-algorithm:frame_length" type="integer" value="11" label="The number of subsequent data points used for smoothing" help="This number has to be uneven. If it is not, 1 will be added"/>
      <param name="polynomial_order" argument="-algorithm:polynomial_order" type="integer" value="4" label="Order or the polynomial that is fitted" help=""/>
    </section>
    <expand macro="adv_opts_macro">
      <param argument="-processOption" type="select" label="Whether to load all data and process them in-memory or whether to process the data on the fly (lowmemory) without loading the whole file into memory first" help="">
        <option value="inmemory" selected="true">inmemory</option>
        <option value="lowmemory">lowmemory</option>
        <expand macro="list_string_san" name="processOption"/>
      </param>
      <param argument="-force" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Overrides tool-specific checks" help=""/>
      <param argument="-test" type="hidden" value="False" label="Enables the test mode (needed for internal use only)" help="" optional="true">
        <expand macro="list_string_san" name="test"/>
      </param>
    </expand>
    <param name="OPTIONAL_OUTPUTS" type="select" optional="true" multiple="true" label="Optional outputs">
      <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="mzml"/>
    <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>
    <!-- TOPP_NoiseFilterSGolay_1 -->
    <test expect_num_outputs="2">
      <section name="adv_opts">
        <param name="processOption" value="inmemory"/>
        <param name="force" value="false"/>
        <param name="test" value="true"/>
      </section>
      <param name="in" value="NoiseFilterSGolay_1_input.mzML"/>
      <output name="out" value="NoiseFilterSGolay_1_output.mzML" compare="sim_size" delta_frac="0.7" ftype="mzml"/>
      <section name="algorithm">
        <param name="frame_length" value="9"/>
        <param name="polynomial_order" value="4"/>
      </section>
      <param name="OPTIONAL_OUTPUTS" value="ctd_out_FLAG"/>
      <output name="ctd_out" ftype="xml">
        <assert_contents>
          <is_valid_xml/>
        </assert_contents>
      </output>
      <assert_stdout>
        <has_text_matching expression="@EXECUTABLE@ took .* \(wall\), .* \(CPU\), .* \(system\), .* \(user\)(; Peak Memory Usage: 32 MB)?."/>
      </assert_stdout>
    </test>
    <!-- TOPP_NoiseFilterSGolay_2 -->
    <test expect_num_outputs="2">
      <section name="adv_opts">
        <param name="processOption" value="inmemory"/>
        <param name="force" value="false"/>
        <param name="test" value="true"/>
      </section>
      <param name="in" value="NoiseFilterSGolay_2_input.chrom.mzML"/>
      <output name="out" value="NoiseFilterSGolay_2_output.chrom.mzML" compare="sim_size" delta_frac="0.7" ftype="mzml"/>
      <section name="algorithm">
        <param name="frame_length" value="11"/>
        <param name="polynomial_order" value="4"/>
      </section>
      <param name="OPTIONAL_OUTPUTS" value="ctd_out_FLAG"/>
      <output name="ctd_out" ftype="xml">
        <assert_contents>
          <is_valid_xml/>
        </assert_contents>
      </output>
      <assert_stdout>
        <has_text_matching expression="@EXECUTABLE@ took .* \(wall\), .* \(CPU\), .* \(system\), .* \(user\)(; Peak Memory Usage: 32 MB)?."/>
      </assert_stdout>
    </test>
    <!-- TOPP_NoiseFilterSGolay_3 -->
    <test expect_num_outputs="2">
      <section name="adv_opts">
        <param name="processOption" value="lowmemory"/>
        <param name="force" value="false"/>
        <param name="test" value="true"/>
      </section>
      <param name="in" value="NoiseFilterSGolay_1_input.mzML"/>
      <output name="out" value="NoiseFilterSGolay_1_output.mzML" compare="sim_size" delta_frac="0.7" ftype="mzml"/>
      <section name="algorithm">
        <param name="frame_length" value="9"/>
        <param name="polynomial_order" value="4"/>
      </section>
      <param name="OPTIONAL_OUTPUTS" value="ctd_out_FLAG"/>
      <output name="ctd_out" ftype="xml">
        <assert_contents>
          <is_valid_xml/>
        </assert_contents>
      </output>
      <assert_stdout>
        <has_text_matching expression="@EXECUTABLE@ took .* \(wall\), .* \(CPU\), .* \(system\), .* \(user\)(; Peak Memory Usage: 32 MB)?."/>
      </assert_stdout>
    </test>
    <!-- TOPP_NoiseFilterSGolay_4 -->
    <test expect_num_outputs="2">
      <section name="adv_opts">
        <param name="processOption" value="lowmemory"/>
        <param name="force" value="false"/>
        <param name="test" value="true"/>
      </section>
      <param name="in" value="NoiseFilterSGolay_2_input.chrom.mzML"/>
      <output name="out" value="NoiseFilterSGolay_2_output.chrom.mzML" compare="sim_size" delta_frac="0.7" ftype="mzml"/>
      <section name="algorithm">
        <param name="frame_length" value="11"/>
        <param name="polynomial_order" value="4"/>
      </section>
      <param name="OPTIONAL_OUTPUTS" value="ctd_out_FLAG"/>
      <output name="ctd_out" ftype="xml">
        <assert_contents>
          <is_valid_xml/>
        </assert_contents>
      </output>
      <assert_stdout>
        <has_text_matching expression="@EXECUTABLE@ took .* \(wall\), .* \(CPU\), .* \(system\), .* \(user\)(; Peak Memory Usage: 32 MB)?."/>
      </assert_stdout>
    </test>
  </tests>
  <help><![CDATA[Removes noise from profile spectra by using a Savitzky Golay filter. Requires uniform (equidistant) data.


For more information, visit https://openms.de/doxygen/release/3.1.0/html/TOPP_NoiseFilterSGolay.html]]></help>
  <expand macro="references"/>
</tool>