diff MassTraceExtractor.xml @ 9:5d7b3d2b66a8 draft

"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
author galaxyp
date Thu, 27 Aug 2020 19:38:30 -0400
parents e059a211406b
children d7e537b28220
line wrap: on
line diff
--- a/MassTraceExtractor.xml	Fri May 17 10:12:52 2019 -0400
+++ b/MassTraceExtractor.xml	Thu Aug 27 19:38:30 2020 -0400
@@ -1,157 +1,118 @@
 <?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="MassTraceExtractor" name="MassTraceExtractor" version="2.3.0">
+<tool id="MassTraceExtractor" name="MassTraceExtractor" version="@TOOL_VERSION@+galaxy@GALAXY_VERSION@" profile="20.05">
   <description>Detects mass traces in centroided LC-MS data.</description>
   <macros>
     <token name="@EXECUTABLE@">MassTraceExtractor</token>
     <import>macros.xml</import>
+    <import>macros_autotest.xml</import>
+    <import>macros_test.xml</import>
   </macros>
-  <expand macro="references"/>
+  <expand macro="requirements"/>
   <expand macro="stdio"/>
-  <expand macro="requirements"/>
-  <command detect_errors="aggressive"><![CDATA[MassTraceExtractor
+  <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.${out_type}'
 
-#if $param_in:
-  -in $param_in
-#end if
-#if $param_out:
-  -out $param_out
-#end if
-#if $param_out_type:
-  -out_type
-  #if " " in str($param_out_type):
-    "$param_out_type"
-  #else
-    $param_out_type
-  #end if
-#end if
-#if $param_algorithm_common_noise_threshold_int:
-  -algorithm:common:noise_threshold_int $param_algorithm_common_noise_threshold_int
-#end if
-#if $param_algorithm_common_chrom_peak_snr:
-  -algorithm:common:chrom_peak_snr $param_algorithm_common_chrom_peak_snr
-#end if
-#if $param_algorithm_common_chrom_fwhm:
-  -algorithm:common:chrom_fwhm $param_algorithm_common_chrom_fwhm
-#end if
-#if $param_algorithm_mtd_mass_error_ppm:
-  -algorithm:mtd:mass_error_ppm $param_algorithm_mtd_mass_error_ppm
-#end if
-#if $param_algorithm_mtd_reestimate_mt_sd:
-  -algorithm:mtd:reestimate_mt_sd
-  #if " " in str($param_algorithm_mtd_reestimate_mt_sd):
-    "$param_algorithm_mtd_reestimate_mt_sd"
-  #else
-    $param_algorithm_mtd_reestimate_mt_sd
-  #end if
-#end if
-#if $param_algorithm_mtd_quant_method:
-  -algorithm:mtd:quant_method
-  #if " " in str($param_algorithm_mtd_quant_method):
-    "$param_algorithm_mtd_quant_method"
-  #else
-    $param_algorithm_mtd_quant_method
-  #end if
-#end if
-#if $param_algorithm_epd_width_filtering:
-  -algorithm:epd:width_filtering
-  #if " " in str($param_algorithm_epd_width_filtering):
-    "$param_algorithm_epd_width_filtering"
-  #else
-    $param_algorithm_epd_width_filtering
-  #end if
-#end if
-#if $param_algorithm_epd_enabled:
-  -algorithm:epd:enabled
-  #if " " in str($param_algorithm_epd_enabled):
-    "$param_algorithm_epd_enabled"
-  #else
-    $param_algorithm_epd_enabled
-  #end if
-#end if
-#if $adv_opts.adv_opts_selector=='advanced':
-    #if $adv_opts.param_force:
-  -force
-#end if
-    #if $adv_opts.param_algorithm_mtd_trace_termination_criterion:
-  -algorithm:mtd:trace_termination_criterion
-  #if " " in str($adv_opts.param_algorithm_mtd_trace_termination_criterion):
-    "$adv_opts.param_algorithm_mtd_trace_termination_criterion"
-  #else
-    $adv_opts.param_algorithm_mtd_trace_termination_criterion
-  #end if
-#end if
-    #if $adv_opts.param_algorithm_mtd_trace_termination_outliers:
-  -algorithm:mtd:trace_termination_outliers $adv_opts.param_algorithm_mtd_trace_termination_outliers
-#end if
-    #if $adv_opts.param_algorithm_mtd_min_sample_rate:
-  -algorithm:mtd:min_sample_rate $adv_opts.param_algorithm_mtd_min_sample_rate
-#end if
-    #if $adv_opts.param_algorithm_mtd_min_trace_length:
-  -algorithm:mtd:min_trace_length $adv_opts.param_algorithm_mtd_min_trace_length
-#end if
-    #if $adv_opts.param_algorithm_mtd_max_trace_length:
-  -algorithm:mtd:max_trace_length $adv_opts.param_algorithm_mtd_max_trace_length
-#end if
-    #if $adv_opts.param_algorithm_epd_min_fwhm:
-  -algorithm:epd:min_fwhm $adv_opts.param_algorithm_epd_min_fwhm
-#end if
-    #if $adv_opts.param_algorithm_epd_max_fwhm:
-  -algorithm:epd:max_fwhm $adv_opts.param_algorithm_epd_max_fwhm
-#end if
-    #if $adv_opts.param_algorithm_epd_masstrace_snr_filtering:
-  -algorithm:epd:masstrace_snr_filtering
-#end if
-#end if
-]]></command>
+## Postprocessing
+&& mv 'out/output.${out_type}' '$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="param_in" type="data" format="mzml" optional="False" label="input centroided mzML file" help="(-in) "/>
-    <param name="param_out_type" display="radio" type="select" optional="True" label="output file type -- default: determined from file extension or content" help="(-out_type) ">
-      <option value="featureXML">featureXML</option>
-      <option value="consensusXML">consensusXML</option>
-    </param>
-    <param name="param_algorithm_common_noise_threshold_int" type="float" value="10.0" label="Intensity threshold below which peaks are regarded as noise" help="(-noise_threshold_int) "/>
-    <param name="param_algorithm_common_chrom_peak_snr" type="float" value="3.0" label="Minimum signal-to-noise a mass trace should have" help="(-chrom_peak_snr) "/>
-    <param name="param_algorithm_common_chrom_fwhm" type="float" value="5.0" label="Expected chromatographic peak width (in seconds)" help="(-chrom_fwhm) "/>
-    <param name="param_algorithm_mtd_mass_error_ppm" type="float" value="20.0" label="Allowed mass deviation (in ppm)" help="(-mass_error_ppm) "/>
-    <param name="param_algorithm_mtd_reestimate_mt_sd" display="radio" type="select" optional="False" value="true" label="Enables dynamic re-estimation of m/z variance during mass trace collection stage" help="(-reestimate_mt_sd) ">
-      <option value="true" selected="true">true</option>
-      <option value="false">false</option>
-    </param>
-    <param name="param_algorithm_mtd_quant_method" display="radio" type="select" optional="False" value="area" label="Method of quantification for mass traces" help="(-quant_method) For LC data 'area' is recommended, 'median' for direct injection data">
-      <option value="area" selected="true">area</option>
-      <option value="median">median</option>
+    <param name="in" argument="-in" type="data" format="mzml" optional="false" label="input centroided mzML file" help=" select mzml data sets(s)"/>
+    <param name="out_type" argument="-out_type" display="radio" type="select" optional="false" label="output file type -- default: determined from file extension or content" help="">
+      <option value="consensusXML">consensusxml</option>
+      <option value="featureXML">featurexml</option>
+      <expand macro="list_string_san"/>
     </param>
-    <param name="param_algorithm_epd_width_filtering" display="radio" type="select" optional="False" value="fixed" label="Enable filtering of unlikely peak widths" help="(-width_filtering) The fixed setting filters out mass traces outside the [min_fwhm, max_fwhm] interval (set parameters accordingly!). The auto setting filters with the 5 and 95% quantiles of the peak width distribution">
-      <option value="off">off</option>
-      <option value="fixed" selected="true">fixed</option>
-      <option value="auto">auto</option>
-    </param>
-    <param name="param_algorithm_epd_enabled" display="radio" type="select" optional="False" value="true" label="Enables/disables the chromatographic peak detection of mass traces" help="(-enabled) ">
-      <option value="true" selected="true">true</option>
-      <option value="false">false</option>
+    <section name="algorithm" title="Algorithm parameters section" help="" expanded="false">
+      <section name="common" title="" help="" expanded="false">
+        <param name="noise_threshold_int" argument="-algorithm:common:noise_threshold_int" type="float" optional="true" value="10.0" label="Intensity threshold below which peaks are regarded as noise" help=""/>
+        <param name="chrom_peak_snr" argument="-algorithm:common:chrom_peak_snr" type="float" optional="true" value="3.0" label="Minimum signal-to-noise a mass trace should have" help=""/>
+        <param name="chrom_fwhm" argument="-algorithm:common:chrom_fwhm" type="float" optional="true" value="5.0" label="Expected chromatographic peak width (in seconds)" help=""/>
+      </section>
+      <section name="mtd" title="" help="" expanded="false">
+        <param name="mass_error_ppm" argument="-algorithm:mtd:mass_error_ppm" type="float" optional="true" value="20.0" label="Allowed mass deviation (in ppm)" help=""/>
+        <param name="reestimate_mt_sd" argument="-algorithm:mtd:reestimate_mt_sd" type="boolean" truevalue="true" falsevalue="false" checked="true" label="Enables dynamic re-estimation of m/z variance during mass trace collection stage" help=""/>
+        <param name="quant_method" argument="-algorithm:mtd:quant_method" display="radio" type="select" optional="false" label="Method of quantification for mass traces" help="For LC data 'area' is recommended, 'median' for direct injection data. 'max_height' simply uses the most intense peak in the trace">
+          <option value="area" selected="true">area</option>
+          <option value="median">median</option>
+          <option value="max_height">max_height</option>
+          <expand macro="list_string_san"/>
+        </param>
+        <param name="trace_termination_criterion" argument="-algorithm:mtd:trace_termination_criterion" display="radio" type="select" optional="false" label="Termination criterion for the extension of mass traces" help="In 'outlier' mode, trace extension cancels if a predefined number of consecutive outliers are found (see trace_termination_outliers parameter). In 'sample_rate' mode, trace extension in both directions stops if ratio of found peaks versus visited spectra falls below the 'min_sample_rate' threshold">
+          <option value="outlier" selected="true">outlier</option>
+          <option value="sample_rate">sample_rate</option>
+          <expand macro="list_string_san"/>
+        </param>
+        <param name="trace_termination_outliers" argument="-algorithm:mtd:trace_termination_outliers" type="integer" optional="true" value="5" label="Mass trace extension in one direction cancels if this number of consecutive spectra with no detectable peaks is reached" help=""/>
+        <param name="min_sample_rate" argument="-algorithm:mtd:min_sample_rate" type="float" optional="true" value="0.5" label="Minimum fraction of scans along the mass trace that must contain a peak" help=""/>
+        <param name="min_trace_length" argument="-algorithm:mtd:min_trace_length" type="float" optional="true" value="5.0" label="Minimum expected length of a mass trace (in seconds)" help=""/>
+        <param name="max_trace_length" argument="-algorithm:mtd:max_trace_length" type="float" optional="true" value="-1.0" label="Maximum expected length of a mass trace (in seconds)" help="Set to a negative value to disable maximal length check during mass trace detection"/>
+      </section>
+      <section name="epd" title="" help="" expanded="false">
+        <param name="width_filtering" argument="-algorithm:epd:width_filtering" display="radio" type="select" optional="false" label="Enable filtering of unlikely peak widths" help="The fixed setting filters out mass traces outside the [min_fwhm, max_fwhm] interval (set parameters accordingly!). The auto setting filters with the 5 and 95% quantiles of the peak width distribution">
+          <option value="off">off</option>
+          <option value="fixed" selected="true">fixed</option>
+          <option value="auto">auto</option>
+          <expand macro="list_string_san"/>
+        </param>
+        <param name="min_fwhm" argument="-algorithm:epd:min_fwhm" type="float" optional="true" value="3.0" label="Minimum full-width-at-half-maximum of chromatographic peaks (in seconds)" help="Ignored if parameter width_filtering is off or auto"/>
+        <param name="max_fwhm" argument="-algorithm:epd:max_fwhm" type="float" optional="true" value="60.0" label="Maximum full-width-at-half-maximum of chromatographic peaks (in seconds)" help="Ignored if parameter width_filtering is off or auto"/>
+        <param name="masstrace_snr_filtering" argument="-algorithm:epd:masstrace_snr_filtering" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Apply post-filtering by signal-to-noise ratio after smoothing" help=""/>
+        <param name="enabled" argument="-algorithm:epd:enabled" type="boolean" truevalue="true" falsevalue="false" checked="true" label="Enables/disables the chromatographic peak detection of mass traces" help=""/>
+      </section>
+    </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>
-    <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) "/>
-      <param name="param_algorithm_mtd_trace_termination_criterion" display="radio" type="select" optional="False" value="outlier" label="Termination criterion for the extension of mass traces" help="(-trace_termination_criterion) In 'outlier' mode, trace extension cancels if a predefined number of consecutive outliers are found (see trace_termination_outliers parameter). In 'sample_rate' mode, trace extension in both directions stops if ratio of found peaks versus visited spectra falls below the 'min_sample_rate' threshold">
-        <option value="outlier" selected="true">outlier</option>
-        <option value="sample_rate">sample_rate</option>
-      </param>
-      <param name="param_algorithm_mtd_trace_termination_outliers" type="integer" value="5" label="Mass trace extension in one direction cancels if this number of consecutive spectra with no detectable peaks is reached" help="(-trace_termination_outliers) "/>
-      <param name="param_algorithm_mtd_min_sample_rate" type="float" value="0.5" label="Minimum fraction of scans along the mass trace that must contain a peak" help="(-min_sample_rate) "/>
-      <param name="param_algorithm_mtd_min_trace_length" type="float" value="5.0" label="Minimum expected length of a mass trace (in seconds)" help="(-min_trace_length) "/>
-      <param name="param_algorithm_mtd_max_trace_length" type="float" value="-1.0" label="Maximum expected length of a mass trace (in seconds)" help="(-max_trace_length) Set to a negative value to disable maximal length check during mass trace detection"/>
-      <param name="param_algorithm_epd_min_fwhm" type="float" value="3.0" label="Minimum full-width-at-half-maximum of chromatographic peaks (in seconds)" help="(-min_fwhm) Ignored if parameter width_filtering is off or auto"/>
-      <param name="param_algorithm_epd_max_fwhm" type="float" value="60.0" label="Maximum full-width-at-half-maximum of chromatographic peaks (in seconds)" help="(-max_fwhm) Ignored if parameter width_filtering is off or auto"/>
-      <param name="param_algorithm_epd_masstrace_snr_filtering" display="radio" type="boolean" truevalue="-algorithm:epd:masstrace_snr_filtering" falsevalue="" checked="false" optional="True" label="Apply post-filtering by signal-to-noise ratio after smoothing" help="(-masstrace_snr_filtering) "/>
-    </expand>
   </inputs>
   <outputs>
-    <data name="param_out" format="featurexml"/>
+    <data name="out" label="${tool.name} on ${on_string}: out">
+      <change_format>
+        <when input="out_type" value="consensusXML" format="consensusxml"/>
+        <when input="out_type" value="featureXML" format="featurexml"/>
+      </change_format>
+    </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>
-  <help>Detects mass traces in centroided LC-MS data.
+  <tests>
+    <expand macro="autotest_MassTraceExtractor"/>
+    <expand macro="manutest_MassTraceExtractor"/>
+  </tests>
+  <help><![CDATA[Detects mass traces in centroided LC-MS data.
 
 
-For more information, visit https://abibuilder.informatik.uni-tuebingen.de/archive/openms/Documentation/release/2.3.0/html/TOPP_MassTraceExtractor.html</help>
+For more information, visit http://www.openms.de/documentation/TOPP_MassTraceExtractor.html]]></help>
+  <expand macro="references"/>
 </tool>