diff OpenSwathDecoyGenerator.xml @ 9:1814187218fe draft

"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
author galaxyp
date Wed, 09 Sep 2020 20:15:46 +0000
parents 5cc0f0e55785
children 3769d3a7e9ba
line wrap: on
line diff
--- a/OpenSwathDecoyGenerator.xml	Fri May 17 10:13:41 2019 -0400
+++ b/OpenSwathDecoyGenerator.xml	Wed Sep 09 20:15:46 2020 +0000
@@ -1,132 +1,109 @@
 <?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: [Targeted Experiments]-->
-<tool id="OpenSwathDecoyGenerator" name="OpenSwathDecoyGenerator" version="2.3.0">
+<tool id="OpenSwathDecoyGenerator" name="OpenSwathDecoyGenerator" version="@TOOL_VERSION@+galaxy@GALAXY_VERSION@" profile="20.05">
   <description>Generates decoys according to different models for a specific TraML</description>
   <macros>
     <token name="@EXECUTABLE@">OpenSwathDecoyGenerator</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[OpenSwathDecoyGenerator
+  <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_method:
-  -method     "$param_method"
-#end if
-#if $param_decoy_tag:
-  -decoy_tag     "$param_decoy_tag"
-#end if
-#if $param_mz_threshold:
-  -mz_threshold $param_mz_threshold
-#end if
-#if $param_exclude_similar:
-  -exclude_similar
-#end if
-#if $param_similarity_threshold:
-  -similarity_threshold $param_similarity_threshold
-#end if
-#if $param_append:
-  -append
-#end if
-#if $param_remove_CNterm_mods:
-  -remove_CNterm_mods
-#end if
-#if $param_remove_unannotated:
-  -remove_unannotated
-#end if
-#if $param_identity_threshold:
-  -identity_threshold $param_identity_threshold
-#end if
-#if $param_max_attempts:
-  -max_attempts $param_max_attempts
-#end if
-#if $param_mz_shift:
-  -mz_shift $param_mz_shift
-#end if
-#if $param_precursor_mass_shift:
-  -precursor_mass_shift $param_precursor_mass_shift
-#end if
-#if $param_allowed_fragment_types:
-  -allowed_fragment_types     "$param_allowed_fragment_types"
-#end if
-#if $param_allowed_fragment_charges:
-  -allowed_fragment_charges     "$param_allowed_fragment_charges"
-#end if
-#if $param_enable_detection_specific_losses:
-  -enable_detection_specific_losses
-#end if
-#if $param_enable_detection_unspecific_losses:
-  -enable_detection_unspecific_losses
-#end if
-#if $adv_opts.adv_opts_selector=='advanced':
-    #if $adv_opts.param_force:
-  -force
-#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="traml" optional="False" label="input file ('traML')" help="(-in) "/>
-    <param name="param_method" type="text" size="30" value="shuffle" label="decoy generation method ('shuffle','pseudo-reverse','reverse','shift')" help="(-method) ">
-      <sanitizer>
-        <valid initial="string.printable">
-          <remove value="'"/>
-          <remove value="&quot;"/>
-        </valid>
-      </sanitizer>
+    <param name="in" argument="-in" type="data" format="mrm,pqp,tabular,traml" optional="false" label="Input file" help=" select mrm,pqp,tabular,traml 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="TraML">traml</option>
+      <option value="pqp">pqp</option>
+      <option value="tsv">tabular (tsv)</option>
+      <expand macro="list_string_san"/>
     </param>
-    <param name="param_decoy_tag" type="text" size="30" value="DECOY_" label="decoy tag" help="(-decoy_tag) ">
-      <sanitizer>
-        <valid initial="string.printable">
-          <remove value="'"/>
-          <remove value="&quot;"/>
-        </valid>
-      </sanitizer>
+    <param name="method" argument="-method" display="radio" type="select" optional="false" label="decoy generation method ('shuffle','pseudo-reverse','reverse','shift')" help="">
+      <option value="shuffle" selected="true">shuffle</option>
+      <option value="pseudo-reverse">pseudo-reverse</option>
+      <option value="reverse">reverse</option>
+      <option value="shift">shift</option>
+      <expand macro="list_string_san"/>
+    </param>
+    <param name="decoy_tag" argument="-decoy_tag" type="text" optional="true" value="DECOY_" label="decoy tag" help="">
+      <expand macro="list_string_san"/>
     </param>
-    <param name="param_mz_threshold" type="float" value="0.05" label="MZ threshold in Thomson for fragment ion annotation" help="(-mz_threshold) "/>
-    <param name="param_exclude_similar" display="radio" type="boolean" truevalue="-exclude_similar" falsevalue="" checked="false" optional="True" label="set this flag if decoy assays with similarity of the peptide sequence to the target assays higher than the identity_threshold should be excluded" help="(-exclude_similar) If similarity_threshold is over 0, decoy assays with an absolute difference of the decoy and target product mz smaller than similarity_threshold are further excluded"/>
-    <param name="param_similarity_threshold" type="float" value="-1.0" label="Similarity threshold for absolute difference of the product mz of target and decoy assays for exclusion in Dalton" help="(-similarity_threshold) Suggested value: 0.05"/>
-    <param name="param_append" display="radio" type="boolean" truevalue="-append" falsevalue="" checked="false" optional="True" label="set this flag if non-decoy TraML should be appended to the output" help="(-append) "/>
-    <param name="param_remove_CNterm_mods" display="radio" type="boolean" truevalue="-remove_CNterm_mods" falsevalue="" checked="false" optional="True" label="set this flag to remove decoy peptides with C/N terminal modifications (may be necessary depending on the decoy generation method)" help="(-remove_CNterm_mods) "/>
-    <param name="param_remove_unannotated" display="radio" type="boolean" truevalue="-remove_unannotated" falsevalue="" checked="false" optional="True" label="set this flag if target assays with unannotated ions should be ignored from decoy generation" help="(-remove_unannotated) "/>
-    <param name="param_identity_threshold" type="float" value="0.7" label="shuffle: identity threshold for the shuffle algorithm" help="(-identity_threshold) "/>
-    <param name="param_max_attempts" type="integer" value="10" label="shuffle: maximum attempts to lower the sequence identity between target and decoy for the shuffle algorithm" help="(-max_attempts) "/>
-    <param name="param_mz_shift" type="float" value="20.0" label="shift: MZ shift in Thomson for shift decoy method" help="(-mz_shift) "/>
-    <param name="param_precursor_mass_shift" type="float" value="0.0" label="Mass shift to apply to the precursor ion" help="(-precursor_mass_shift) "/>
-    <param name="param_allowed_fragment_types" type="text" size="30" value="b,y" label="allowed fragment types" help="(-allowed_fragment_types) ">
-      <sanitizer>
-        <valid initial="string.printable">
-          <remove value="'"/>
-          <remove value="&quot;"/>
-        </valid>
-      </sanitizer>
+    <param name="switchKR" argument="-switchKR" type="boolean" truevalue="true" falsevalue="false" checked="true" label="Whether to switch terminal K and R (to achieve different precursor mass)" help=""/>
+    <expand macro="adv_opts_macro">
+      <param name="min_decoy_fraction" argument="-min_decoy_fraction" type="float" optional="true" value="0.8" label="Minimum fraction of decoy / target peptides and proteins" help=""/>
+      <param name="aim_decoy_fraction" argument="-aim_decoy_fraction" type="float" optional="true" value="1.0" label="Number of decoys the algorithm should generate (if unequal to 1, the algorithm will randomly select N peptides for decoy generation)" help=""/>
+      <param name="shuffle_max_attempts" argument="-shuffle_max_attempts" type="integer" optional="true" value="30" label="shuffle: maximum attempts to lower the amino acid sequence identity between target and decoy for the shuffle algorithm" help=""/>
+      <param name="shuffle_sequence_identity_threshold" argument="-shuffle_sequence_identity_threshold" type="float" optional="true" value="0.5" label="shuffle: target-decoy amino acid sequence identity threshold for the shuffle algorithm" help=""/>
+      <param name="shift_precursor_mz_shift" argument="-shift_precursor_mz_shift" type="float" optional="true" value="0.0" label="shift: precursor ion MZ shift in Thomson for shift decoy method" help=""/>
+      <param name="shift_product_mz_shift" argument="-shift_product_mz_shift" type="float" optional="true" value="20.0" label="shift: fragment ion MZ shift in Thomson for shift decoy method" help=""/>
+      <param name="product_mz_threshold" argument="-product_mz_threshold" type="float" optional="true" value="0.025" label="MZ threshold in Thomson for fragment ion annotation" help=""/>
+      <param name="allowed_fragment_types" argument="-allowed_fragment_types" type="text" optional="true" value="b,y" label="allowed fragment types" help="">
+        <expand macro="list_string_san"/>
+      </param>
+      <param name="allowed_fragment_charges" argument="-allowed_fragment_charges" type="text" optional="true" value="1,2,3,4" label="allowed fragment charge states" help="">
+        <expand macro="list_string_san"/>
+      </param>
+      <param name="enable_detection_specific_losses" argument="-enable_detection_specific_losses" type="boolean" truevalue="true" falsevalue="false" checked="false" label="set this flag if specific neutral losses for detection fragment ions should be allowed" help=""/>
+      <param name="enable_detection_unspecific_losses" argument="-enable_detection_unspecific_losses" type="boolean" truevalue="true" falsevalue="false" checked="false" label="set this flag if unspecific neutral losses (H2O1, H3N1, C1H2N2, C1H2N1O1) for detection fragment ions should be allowed" help=""/>
+      <param name="separate" argument="-separate" type="boolean" truevalue="true" falsevalue="false" checked="false" label="set this flag if decoys should not be appended to targets" help=""/>
+      <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>
-    <param name="param_allowed_fragment_charges" type="text" size="30" value="1,2,3,4" label="allowed fragment charge states" help="(-allowed_fragment_charges) ">
-      <sanitizer>
-        <valid initial="string.printable">
-          <remove value="'"/>
-          <remove value="&quot;"/>
-        </valid>
-      </sanitizer>
-    </param>
-    <param name="param_enable_detection_specific_losses" display="radio" type="boolean" truevalue="-enable_detection_specific_losses" falsevalue="" checked="false" optional="True" label="set this flag if specific neutral losses for detection fragment ions should be allowed" help="(-enable_detection_specific_losses) "/>
-    <param name="param_enable_detection_unspecific_losses" display="radio" type="boolean" truevalue="-enable_detection_unspecific_losses" falsevalue="" checked="false" optional="True" label="set this flag if unspecific neutral losses (H2O1, H3N1, C1H2N2, C1H2N1O1) for detection fragment ions should be allowed" help="(-enable_detection_unspecific_losses) "/>
-    <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) "/>
-    </expand>
   </inputs>
   <outputs>
-    <data name="param_out" format="traml"/>
+    <data name="out" label="${tool.name} on ${on_string}: out">
+      <change_format>
+        <when input="out_type" value="TraML" format="traml"/>
+        <when input="out_type" value="pqp" format="pqp"/>
+        <when input="out_type" value="tsv" format="tabular"/>
+      </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>Generates decoys according to different models for a specific TraML
+  <tests>
+    <expand macro="autotest_OpenSwathDecoyGenerator"/>
+    <expand macro="manutest_OpenSwathDecoyGenerator"/>
+  </tests>
+  <help><![CDATA[Generates decoys according to different models for a specific TraML
 
 
-For more information, visit https://abibuilder.informatik.uni-tuebingen.de/archive/openms/Documentation/release/2.3.0/html/TOPP_OpenSwathDecoyGenerator.html</help>
+For more information, visit http://www.openms.de/documentation/TOPP_OpenSwathDecoyGenerator.html]]></help>
+  <expand macro="references"/>
 </tool>