annotate PeakPickerWavelet.xml @ 11:341af0b11af9 draft

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

<?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: [Signal processing and preprocessing]-->
<tool id="PeakPickerWavelet" name="PeakPickerWavelet" version="@TOOL_VERSION@+galaxy@GALAXY_VERSION@" profile="20.05">
  <description>Finds mass spectrometric peaks in profile mass spectra.</description>
  <macros>
    <token name="@EXECUTABLE@">PeakPickerWavelet</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 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 name="in" argument="-in" type="data" format="mzml" optional="false" label="input profile data file" help=" select mzml data sets(s)"/>
    <section name="algorithm" title="Algorithm parameters section" help="" expanded="false">
      <param name="signal_to_noise" argument="-algorithm:signal_to_noise" type="float" optional="true" min="0.0" value="1.0" label="Minimal signal to noise ratio for a peak to be picked" help=""/>
      <param name="centroid_percentage" argument="-algorithm:centroid_percentage" type="float" optional="true" min="0.0" max="1.0" value="0.8" label="Percentage of the maximum height that the raw data points must exceed to be taken into account for the calculation of the centroid" help="If it is 1 the centroid position corresponds to the position of the highest intensity"/>
      <param name="peak_width" argument="-algorithm:peak_width" type="float" optional="true" min="0.0" value="0.15" label="Approximate fwhm of the peaks" help=""/>
      <param name="estimate_peak_width" argument="-algorithm:estimate_peak_width" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Flag if the average peak width shall be estimated" help="Attention: when this flag is set, the peak_width is ignored"/>
      <param name="fwhm_lower_bound_factor" argument="-algorithm:fwhm_lower_bound_factor" type="float" optional="true" min="0.0" value="0.7" label="Factor that calculates the minimal fwhm value from the peak_width" help="All peaks with width smaller than fwhm_bound_factor * peak_width are discarded"/>
      <param name="fwhm_upper_bound_factor" argument="-algorithm:fwhm_upper_bound_factor" type="float" optional="true" min="0.0" value="20.0" label="Factor that calculates the maximal fwhm value from the peak_width" help="All peaks with width greater than fwhm_upper_bound_factor * peak_width are discarded"/>
      <section name="optimization" title="" help="" expanded="false">
        <param name="iterations" argument="-algorithm:optimization:iterations" type="integer" optional="true" min="1" value="400" label="maximal number of iterations for the fitting step" help=""/>
        <section name="penalties" title="" help="" expanded="false">
          <param name="position" argument="-algorithm:optimization:penalties:position" type="float" optional="true" min="0.0" value="0.0" label="penalty term for the fitting of the position:If it differs too much from the initial one it can be penalized" help=""/>
          <param name="left_width" argument="-algorithm:optimization:penalties:left_width" type="float" optional="true" min="0.0" value="1.0" label="penalty term for the fitting of the left width:If the left width differs too much from the initial one during the fitting it can be penalized" help=""/>
          <param name="right_width" argument="-algorithm:optimization:penalties:right_width" type="float" optional="true" min="0.0" value="1.0" label="penalty term for the fitting of the right width:If the right width differs too much from the initial one during the fitting it can be penalized" help=""/>
          <param name="height" argument="-algorithm:optimization:penalties:height" type="float" optional="true" min="0.0" value="1.0" label="penalty term for the fitting of the intensity (only used in 2D Optimization):If it gets negative during the fitting it can be penalized" help=""/>
        </section>
        <section name="2d" title="" help="" expanded="false">
          <param name="tolerance_mz" argument="-algorithm:optimization:2d:tolerance_mz" type="float" optional="true" min="0.0" value="2.2" label="mz tolerance for cluster construction" help=""/>
          <param name="max_peak_distance" argument="-algorithm:optimization:2d:max_peak_distance" type="float" optional="true" min="0.0" value="1.2" label="maximal peak distance in mz in a cluste" help=""/>
        </section>
      </section>
      <section name="thresholds" title="" help="" expanded="false">
        <param name="peak_bound" argument="-algorithm:thresholds:peak_bound" type="float" optional="true" min="0.0" value="10.0" label="Minimal peak intensity" help=""/>
        <param name="peak_bound_ms2_level" argument="-algorithm:thresholds:peak_bound_ms2_level" type="float" optional="true" min="0.0" value="10.0" label="Minimal peak intensity for MS/MS peaks" help=""/>
        <param name="correlation" argument="-algorithm:thresholds:correlation" type="float" optional="true" min="0.0" max="1.0" value="0.5" label="minimal correlation of a peak and the raw signal" help="If a peak has a lower correlation it is skipped"/>
        <param name="noise_level" argument="-algorithm:thresholds:noise_level" type="float" optional="true" min="0.0" value="0.1" label="noise level for the search of the peak endpoints" help=""/>
        <param name="search_radius" argument="-algorithm:thresholds:search_radius" type="integer" optional="true" min="0" value="3" label="search radius for the search of the maximum in the signal after a maximum in the cwt was found" help=""/>
      </section>
      <section name="wavelet_transform" title="" help="" expanded="false">
        <param name="spacing" argument="-algorithm:wavelet_transform:spacing" type="float" optional="true" min="0.0" value="0.001" label="Spacing of the CWT" help="Note that the accuracy of the picked peak's centroid position depends in the Raw data spacing, i.e., 50% of raw peak distance at most"/>
      </section>
      <section name="deconvolution" title="" help="" expanded="false">
        <param name="deconvolution" argument="-algorithm:deconvolution:deconvolution" type="boolean" truevalue="true" falsevalue="false" checked="false" label="If you want heavily overlapping peaks to be separated set this value to &quot;true&quot;" help=""/>
        <param name="asym_threshold" argument="-algorithm:deconvolution:asym_threshold" type="float" optional="true" min="0.0" value="0.3" label="If the symmetry of a peak is smaller than asym_thresholds it is assumed that it consists of more than one peak and the deconvolution procedure is started" help=""/>
        <param name="left_width" argument="-algorithm:deconvolution:left_width" type="float" optional="true" min="0.0" value="2.0" label="1/left_width is the initial value for the left width of the peaks found in the deconvolution step" help=""/>
        <param name="right_width" argument="-algorithm:deconvolution:right_width" type="float" optional="true" min="0.0" value="2.0" label="1/right_width is the initial value for the right width of the peaks found in the deconvolution step" help=""/>
        <param name="scaling" argument="-algorithm:deconvolution:scaling" type="float" optional="true" min="0.0" value="0.12" label="Initial scaling of the cwt used in the separation of heavily overlapping peaks" help="The initial value is used for charge 1, for higher charges it is adapted to scaling/charge"/>
        <section name="fitting" title="" help="" expanded="false">
          <param name="fwhm_threshold" argument="-algorithm:deconvolution:fitting:fwhm_threshold" type="float" optional="true" min="0.0" value="0.7" label="If the FWHM of a peak is higher than 'fwhm_thresholds' it is assumed that it consists of more than one peak and the deconvolution procedure is started" help=""/>
          <param name="eps_abs" argument="-algorithm:deconvolution:fitting:eps_abs" type="float" optional="true" min="0.0" value="9.999999747378752e-06" label="if the absolute error gets smaller than this value the fitting is stopped" help=""/>
          <param name="eps_rel" argument="-algorithm:deconvolution:fitting:eps_rel" type="float" optional="true" min="0.0" value="9.999999747378752e-06" label="if the relative error gets smaller than this value the fitting is stopped" help=""/>
          <param name="max_iteration" argument="-algorithm:deconvolution:fitting:max_iteration" type="integer" optional="true" min="1" value="10" label="maximal number of iterations for the fitting step" help=""/>
          <section name="penalties" title="" help="" expanded="false">
            <param name="position" argument="-algorithm:deconvolution:fitting:penalties:position" type="float" optional="true" min="0.0" value="0.0" label="penalty term for the fitting of the peak position:If the position changes more than 0.5Da during the fitting it can be penalized as well as discrepancies of the peptide mass rule" help=""/>
            <param name="height" argument="-algorithm:deconvolution:fitting:penalties:height" type="float" optional="true" min="0.0" value="1.0" label="penalty term for the fitting of the intensity:If it gets negative during the fitting it can be penalized" help=""/>
            <param name="left_width" argument="-algorithm:deconvolution:fitting:penalties:left_width" type="float" optional="true" min="0.0" value="0.0" label="penalty term for the fitting of the left width:If the left width gets too broad or negative during the fitting it can be penalized" help=""/>
            <param name="right_width" argument="-algorithm:deconvolution:fitting:penalties:right_width" type="float" optional="true" min="0.0" value="0.0" label="penalty term for the fitting of the right width:If the right width gets too broad or negative during the fitting it can be penalized" help=""/>
          </section>
        </section>
      </section>
      <section name="SignalToNoiseEstimationParameter" title="" help="" expanded="false">
        <param name="max_intensity" argument="-algorithm:SignalToNoiseEstimationParameter:max_intensity" type="integer" optional="true" min="-1" value="-1" label="maximal intensity considered for histogram construction" help="By default, it will be calculated automatically (see auto_mode). Only provide this parameter if you know what you are doing (and change 'auto_mode' to '-1')! All intensities EQUAL/ABOVE 'max_intensity' will not be added to the histogram. If you choose 'max_intensity' too small, the noise estimate might be too small as well. If chosen too big, the bins become quite large (which you could counter by increasing 'bin_count', which increases runtime)"/>
        <param name="auto_max_stdev_factor" argument="-algorithm:SignalToNoiseEstimationParameter:auto_max_stdev_factor" type="float" optional="true" min="0.0" max="999.0" value="3.0" label="parameter for 'max_intensity' estimation (if 'auto_mode' == 0): mean + 'auto_max_stdev_factor' * stdev" help=""/>
        <param name="auto_max_percentile" argument="-algorithm:SignalToNoiseEstimationParameter:auto_max_percentile" type="integer" optional="true" min="0" max="100" value="95" label="parameter for 'max_intensity' estimation (if 'auto_mode' == 1): auto_max_percentile th percentile" help=""/>
        <param name="auto_mode" argument="-algorithm:SignalToNoiseEstimationParameter:auto_mode" type="integer" optional="true" min="-1" max="1" value="0" label="method to use to determine maximal intensity: -1 --&gt; use 'max_intensity'; 0 --&gt; 'auto_max_stdev_factor' method (default); 1 --&gt; 'auto_max_percentile' method" help=""/>
        <param name="win_len" argument="-algorithm:SignalToNoiseEstimationParameter:win_len" type="float" optional="true" min="1.0" value="200.0" label="window length in Thomson" help=""/>
        <param name="bin_count" argument="-algorithm:SignalToNoiseEstimationParameter:bin_count" type="integer" optional="true" min="3" value="30" label="number of bins for intensity values" help=""/>
        <param name="stdev_mp" argument="-algorithm:SignalToNoiseEstimationParameter:stdev_mp" type="float" optional="true" min="0.01" max="999.0" value="3.0" label="multiplier for stdev" help=""/>
        <param name="min_required_elements" argument="-algorithm:SignalToNoiseEstimationParameter:min_required_elements" type="integer" optional="true" min="1" value="10" label="minimum number of elements required in a window (otherwise it is considered sparse)" help=""/>
        <param name="noise_for_empty_window" argument="-algorithm:SignalToNoiseEstimationParameter:noise_for_empty_window" type="float" optional="true" value="1e+20" label="noise value used for sparse windows" help=""/>
      </section>
    </section>
    <expand macro="adv_opts_macro">
      <param name="write_peak_meta_data" argument="-write_peak_meta_data" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Write additional information about the picked peaks (maximal intensity, left and right area...) into the mzML-file" help="Attention: this can blow up files, since seven arrays are stored per spectrum!"/>
      <param name="force" argument="-force" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Overrides 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" 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>
    <expand macro="autotest_PeakPickerWavelet"/>
    <expand macro="manutest_PeakPickerWavelet"/>
  </tests>
  <help><![CDATA[Finds mass spectrometric peaks in profile mass spectra.


For more information, visit http://www.openms.de/doxygen/release/2.6.0/html/TOPP_PeakPickerWavelet.html]]></help>
  <expand macro="references"/>
</tool>