Mercurial > repos > galaxyp > openms_peakpickerhires

changeset 1:94b97d2d98a4 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 9a14ed1f2d3c9abdfb080251b3419dd9e0c52a14
author galaxyp
date Wed, 09 Aug 2017 09:04:11 -0400
parents 5ae104d0da6e
children 1abc5d89f6f7
files PeakPickerHiRes.xml datatypes_conf.xml filetypes.txt macros.xml readme.md tool.conf
diffstat 6 files changed, 74 insertions(+), 65 deletions(-) [+]
line wrap: on
line diff
--- a/PeakPickerHiRes.xml	Wed Mar 01 12:21:36 2017 -0500
+++ b/PeakPickerHiRes.xml	Wed Aug 09 09:04:11 2017 -0400
@@ -1,7 +1,7 @@
 <?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 CTD2Galaxy.-->
 <!--Proposed Tool Section: [Signal processing and preprocessing]-->
-<tool id="PeakPickerHiRes" name="PeakPickerHiRes" version="2.1.0">
+<tool id="PeakPickerHiRes" name="PeakPickerHiRes" version="2.2.0">
   <description>Finds mass spectrometric peaks in profile mass spectra.</description>
   <macros>
     <token name="@EXECUTABLE@">PeakPickerHiRes</token>
@@ -36,7 +36,12 @@
   -algorithm:report_FWHM
 #end if
 #if $param_algorithm_report_FWHM_unit:
-  -algorithm:report_FWHM_unit "$param_algorithm_report_FWHM_unit"
+  -algorithm:report_FWHM_unit
+  #if " " in str($param_algorithm_report_FWHM_unit):
+    "$param_algorithm_report_FWHM_unit"
+  #else
+    $param_algorithm_report_FWHM_unit
+  #end if
 #end if
 #if $param_algorithm_SignalToNoise_win_len:
   -algorithm:SignalToNoise:win_len $param_algorithm_SignalToNoise_win_len
@@ -48,11 +53,21 @@
   -algorithm:SignalToNoise:min_required_elements $param_algorithm_SignalToNoise_min_required_elements
 #end if
 #if $param_algorithm_SignalToNoise_write_log_messages:
-  -algorithm:SignalToNoise:write_log_messages $param_algorithm_SignalToNoise_write_log_messages
+  -algorithm:SignalToNoise:write_log_messages
+  #if " " in str($param_algorithm_SignalToNoise_write_log_messages):
+    "$param_algorithm_SignalToNoise_write_log_messages"
+  #else
+    $param_algorithm_SignalToNoise_write_log_messages
+  #end if
 #end if
 #if $adv_opts.adv_opts_selector=='advanced':
     #if $adv_opts.param_processOption:
-  -processOption $adv_opts.param_processOption
+  -processOption
+  #if " " in str($adv_opts.param_processOption):
+    "$adv_opts.param_processOption"
+  #else
+    $adv_opts.param_processOption
+  #end if
 #end if
     #if $adv_opts.param_force:
   -force
@@ -85,9 +100,9 @@
 </command>
   <inputs>
     <param name="param_in" type="data" format="mzml" optional="False" label="input profile data file" help="(-in) "/>
-    <param name="param_algorithm_signal_to_noise" type="float" min="0.0" optional="True" value="1.0" label="Minimal signal-to-noise ratio for a peak to be picked (0.0 disables SNT estimation!)" help="(-signal_to_noise) "/>
+    <param name="param_algorithm_signal_to_noise" type="float" min="0.0" optional="True" value="0.0" label="Minimal signal-to-noise ratio for a peak to be picked (0.0 disables SNT estimation!)" help="(-signal_to_noise) "/>
     <repeat name="rep_param_algorithm_ms_levels" min="0" max="1" title="param_algorithm_ms_levels">
-      <param name="param_algorithm_ms_levels" type="text" min="1" optional="True" size="30" value="1 2" label="List of MS levels for which the peak picking is applied" help="(-ms_levels) Other scans are copied to the output without changes">
+      <param name="param_algorithm_ms_levels" type="text" min="1" optional="True" size="30" value="1" label="List of MS levels for which the peak picking is applied" help="(-ms_levels) Other scans are copied to the output without changes">
         <sanitizer>
           <valid initial="string.printable">
             <remove value="'"/>
@@ -97,9 +112,9 @@
       </param>
     </repeat>
     <param name="param_algorithm_report_FWHM" display="radio" type="boolean" truevalue="-algorithm:report_FWHM" falsevalue="" checked="false" optional="True" label="Add metadata for FWHM (as floatDataArray named 'FWHM' or 'FWHM_ppm', depending on param 'report_FWHM_unit') for each picked peak" help="(-report_FWHM) "/>
-    <param name="param_algorithm_report_FWHM_unit" display="radio" type="select" optional="False" value="relative(ppm)" label="Unit of FWHM. Either absolute in the unit of input," help="(-report_FWHM_unit) e.g. 'm/z' for spectra, or relative as ppm (only sensible for spectra, not chromatograms)">
+    <param name="param_algorithm_report_FWHM_unit" display="radio" type="select" optional="False" value="relative" label="Unit of FWHM. Either absolute in the unit of input," help="(-report_FWHM_unit) e.g. 'm/z' for spectra, or relative as ppm (only sensible for spectra, not chromatograms)">
+      <option value="relative" selected="true">relative</option>
       <option value="absolute">absolute</option>
-      <option value="relative(ppm)" selected="true">relative(ppm)</option>
     </param>
     <param name="param_algorithm_SignalToNoise_win_len" type="float" min="1.0" optional="True" value="200.0" label="window length in Thomson" help="(-win_len) "/>
     <param name="param_algorithm_SignalToNoise_bin_count" type="integer" min="3" optional="True" value="30" label="number of bins for intensity values" help="(-bin_count) "/>
--- a/datatypes_conf.xml	Wed Mar 01 12:21:36 2017 -0500
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,33 +0,0 @@
-<?xml version='1.0' encoding='UTF-8'?>
-<datatypes>
-  <registration converters_path="lib/galaxy/datatypes/converters" display_path="display_applications">
-    <datatype extension="mzxml" type="galaxy.datatypes.proteomics:MzXML" mimetype="application/xml"/>
-    <datatype extension="traml" type="galaxy.datatypes.proteomics:TraML" mimetype="application/xml"/>
-    <datatype extension="idxml" type="galaxy.datatypes.proteomics:IdXM" mimetype="application/xml"/>
-    <datatype extension="txt" type="galaxy.datatypes.data:Text"/>
-    <datatype extension="tabular" type="galaxy.datatypes.tabular:Tabular"/>
-    <datatype extension="txt" type="galaxy.datatypes.data:Text"/>
-    <datatype extension="fasta" type="galaxy.datatypes.sequence:Fasta"/>
-    <datatype extension="mgf" type="galaxy.datatypes.proteomics:Mgf"/>
-    <datatype extension="mzml" type="galaxy.datatypes.proteomics:MzML" mimetype="application/xml"/>
-    <datatype extension="trafoxml" type="galaxy.datatypes.xml:GenericXml" mimetype="application/xml"/>
-    <datatype extension="traml" type="galaxy.datatypes.proteomics:TraML" mimetype="application/xml"/>
-    <datatype extension="msp" type="galaxy.datatypes.proteomics:Msp"/>
-    <datatype extension="html" type="galaxy.datatypes.text:Html" mimetype="text/html"/>
-    <datatype extension="tabular" type="galaxy.datatypes.tabular:Tabular"/>
-    <datatype extension="fasta" type="galaxy.datatypes.sequence:Fasta"/>
-    <datatype extension="tabular" type="galaxy.datatypes.tabular:Tabular"/>
-    <datatype extension="consensusxml" type="galaxy.datatypes.proteomics:ConsensusXML" mimetype="application/xml"/>
-    <datatype extension="xml" type="galaxy.datatypes.xml:GenericXml" mimetype="application/xml"/>
-    <datatype extension="mzq" type="galaxy.datatypes.proteomics:MzQuantML" mimetype="application/xml"/>
-    <datatype extension="grid" type="galaxy.datatypes.data:Grid"/>
-    <datatype extension="pepxml" type="galaxy.datatypes.proteomics:PepXml" mimetype="application/xml"/>
-    <datatype extension="png" type="galaxy.datatypes.images:Png" mimetype="image/png"/>
-    <datatype extension="qcml" type="galaxy.datatypes.xml:GenericXml" mimetype="application/xml"/>
-    <datatype extension="featurexml" type="galaxy.datatypes.proteomics:FeatureXML" mimetype="application/xml"/>
-    <datatype extension="html" type="galaxy.datatypes.text:Html" mimetype="text/html"/>
-    <datatype extension="txt" type="galaxy.datatypes.data:Text"/>
-    <datatype extension="mzid" type="galaxy.datatypes.proteomics:MzIdentML" mimetype="application/xml"/>
-    <datatype extension="txt" type="galaxy.datatypes.data:Text"/>
-  </registration>
-</datatypes>
--- a/filetypes.txt	Wed Mar 01 12:21:36 2017 -0500
+++ b/filetypes.txt	Wed Aug 09 09:04:11 2017 -0400
@@ -14,7 +14,7 @@
 consensusXML  consensusxml      galaxy.datatypes.proteomics:ConsensusXML    application/xml
 edta          tabular           galaxy.datatypes.tabular:Tabular 
 featureXML    featurexml        galaxy.datatypes.proteomics:FeatureXML      application/xml
-idXML         idxml             galaxy.datatypes.proteomics:IdXM            application/xml
+idXML         idxml             galaxy.datatypes.proteomics:IdXML           application/xml
 mzML          mzml              galaxy.datatypes.proteomics:MzML            application/xml
 mzXML         mzxml             galaxy.datatypes.proteomics:MzXML           application/xml
 pepXML        pepxml            galaxy.datatypes.proteomics:PepXml          application/xml
@@ -26,4 +26,4 @@
 msp           msp               galaxy.datatypes.proteomics:Msp
 mzid          mzid              galaxy.datatypes.proteomics:MzIdentML       application/xml
 png           png               galaxy.datatypes.images:Png                 image/png
-mgf           mgf               galaxy.datatypes.proteomics:Mgf
\ No newline at end of file
+mgf           mgf               galaxy.datatypes.proteomics:Mgf
--- a/macros.xml	Wed Mar 01 12:21:36 2017 -0500
+++ b/macros.xml	Wed Aug 09 09:04:11 2017 -0400
@@ -2,7 +2,7 @@
 <macros>
   <xml name="requirements">
     <requirements>
-      <requirement type="package" version="2.1">openms</requirement>
+      <requirement type="package" version="2.2">openms</requirement>
       <requirement type="package" version="15.12.15.2">xtandem</requirement>
       <requirement type="package" version="1.0">fido</requirement>
       <requirement type="package" version="2016.10.26">msgf_plus</requirement>
--- a/readme.md	Wed Mar 01 12:21:36 2017 -0500
+++ b/readme.md	Wed Aug 09 09:04:11 2017 -0400
@@ -14,15 +14,29 @@
 Generating OpenMS wrappers
 ==========================
 
- * install OpenMS (you can do this automatically through the Tool Shed)
+ * install OpenMS (you can do this automatically through Conda)
  * create a folder called CTD
- * inside of your new installed openms/bin folder, execute the following command:
+ * if you installed openms as a binary in a specific directory, execute the following command in the `openms/bin` directory:
     
     ```bash
     for binary in `ls`; do ./$binary -write_ctd /PATH/TO/YOUR/CTD; done;
     ```
     
- * `MetaProSIP.ctd` includes a not supported character: To use it, search for `²` and replace it (e.g. with `^2`).
+ * if there is no binary release (e.g. as with version 2.2), download and unpack the Conda package, find the `bin` folder and create a list of the tools as follow:
+ 
+    ```bash
+    ls >> tools.txt
+    ```
+    
+ * search for the `bin` folder of your conda environment containing OpenMS and do:
+ 
+    ```bash
+    while read p; do
+        ./PATH/TO/BIN/$p -write_ctd /PATH/TO/YOUR/CTD;
+    done <tools.txt
+    ```
+    
+ * You should have all CTD files now. `MetaProSIP.ctd` includes a not supported character: To use it, search for `²` and replace it (e.g. with `^2`).
 
  * clone or install CTDopts
 
@@ -39,10 +53,10 @@
  * clone or install CTD2Galaxy
 
     ```bash
-    git clone https://github.com/blankclemens/CTD2Galaxy.git
+    git clone https://github.com/WorkflowConversion/CTD2Galaxy.git
     ```
     
- * If you have CTDopts and CTD2Galaxy installed you are ready to generate Galaxy Tools from CTD definitions. Change the following command according to your needs, especially the `/PATH/TO` parts. 
+ * If you have CTDopts and CTD2Galaxy installed you are ready to generate Galaxy Tools from CTD definitions. Change the following command according to your needs, especially the `/PATH/TO` parts. The default files are provided in this repository. You might have to install `libxslt` and `lxml` to run it.
 
     ```bash
     python generator.py \ 
@@ -102,17 +116,32 @@
     [...]
     ]]>
     ```
- * In `PeakPickerHiRes.xml`, the parameter `report_FWHM_unit` has to be put in quotation marks. Look for the following line
+    
+ * In `IDFileConverter.xml` the following is needed in the command section at the beginning (check your file to know what to copy where):
  
-        -algorithm:report_FWHM_unit $param_algorithm_report_FWHM_unit
-     
-   and change it to
+   ```
+    <command><![CDATA[
    
-        -algorithm:report_FWHM_unit "$param_algorithm_report_FWHM_unit"
+      ## check input file type
+      #set $in_type = $param_in.ext
+
+      ## create the symlinks to set the proper file extension, since IDFileConverter uses them to choose how to handle the input files
+      ln -s '$param_in' 'param_in.${in_type}' &&
+
+      IDFileConverter
 
- * In `FileConverter.xml` add `auto_format="true"` to the output, e.g.:
+      #if $param_in:
+        -in 'param_in.${in_type}'
+      #end if
+
+        [...]
+        ]]>
+    ```
+
+ * In `IDFileConverter.xml` and `FileConverter.xml` add `auto_format="true"` to the output, e.g.:
  
-        <data name="param_out" metadata_source="param_in" auto_format="true"/>
+   - `<data name="param_out" auto_format="true"/>`
+   - `<data name="param_out" metadata_source="param_in" auto_format="true"/>`
         
  * To add an example test case to `DecoyDatabase.xml` add the following after the output section. If standard settings change you might have to adjust the options and/or the test files.
  
--- a/tool.conf	Wed Mar 01 12:21:36 2017 -0500
+++ b/tool.conf	Wed Aug 09 09:04:11 2017 -0400
@@ -6,13 +6,7 @@
     <tool file="openms/RTModel.xml"/>
     <tool file="openms/RTPredict.xml"/>
   </section>
-  <section id="section-id-DEFAULT" name="DEFAULT">
-    <tool file="openms/OpenSwathFileSplitter.xml"/>
-    <tool file="openms/OpenSwathMzMLFileCacher.xml"/>
-  </section>
   <section id="section-id-TargetedExperiments" name="Targeted Experiments">
-    <tool file="openms/ConvertTraMLToTSV.xml"/>
-    <tool file="openms/ConvertTSVToTraML.xml"/>
     <tool file="openms/InclusionExclusionListCreator.xml"/>
     <tool file="openms/MRMMapper.xml"/>
     <tool file="openms/OpenSwathAnalyzer.xml"/>
@@ -22,13 +16,17 @@
     <tool file="openms/OpenSwathDecoyGenerator.xml"/>
     <tool file="openms/OpenSwathDIAPreScoring.xml"/>
     <tool file="openms/OpenSwathFeatureXMLToTSV.xml"/>
+    <tool file="openms/OpenSwathFileSplitter.xml"/>
+    <tool file="openms/OpenSwathMzMLFileCacher.xml"/>
     <tool file="openms/OpenSwathRewriteToFeatureXML.xml"/>
     <tool file="openms/OpenSwathRTNormalizer.xml"/>
     <tool file="openms/PrecursorIonSelector.xml"/>
+    <tool file="openms/TargetedFileConverter.xml"/>
   </section>
   <section id="section-id-Utilities" name="Utilities">
     <tool file="openms/AccurateMassSearch.xml"/>
     <tool file="openms/CVInspector.xml"/>
+    <tool file="openms/DatabaseFilter.xml"/>
     <tool file="openms/DecoyDatabase.xml"/>
     <tool file="openms/DeMeanderize.xml"/>
     <tool file="openms/Digestor.xml"/>
@@ -44,7 +42,6 @@
     <tool file="openms/LabeledEval.xml"/>
     <tool file="openms/LowMemPeakPickerHiRes.xml"/>
     <tool file="openms/LowMemPeakPickerHiRes_RandomAccess.xml"/>
-    <tool file="openms/MapAlignmentEvaluation.xml"/>
     <tool file="openms/MassCalculator.xml"/>
     <tool file="openms/MetaboliteSpectralMatcher.xml"/>
     <tool file="openms/MetaProSIP.xml"/>
@@ -62,12 +59,14 @@
     <tool file="openms/QCMerger.xml"/>
     <tool file="openms/QCShrinker.xml"/>
     <tool file="openms/RNPxl.xml"/>
+    <tool file="openms/RNPxlSearch.xml"/>
     <tool file="openms/RNPxlXICFilter.xml"/>
     <tool file="openms/RTEvaluation.xml"/>
     <tool file="openms/SemanticValidator.xml"/>
     <tool file="openms/SequenceCoverageCalculator.xml"/>
     <tool file="openms/SimpleSearchEngine.xml"/>
     <tool file="openms/SpecLibCreator.xml"/>
+    <tool file="openms/SpectraSTSearchAdapter.xml"/>
     <tool file="openms/SvmTheoreticalSpectrumGeneratorTrainer.xml"/>
     <tool file="openms/TICCalculator.xml"/>
     <tool file="openms/TopPerc.xml"/>
@@ -78,6 +77,7 @@
     <tool file="openms/ConsensusMapNormalizer.xml"/>
     <tool file="openms/FeatureLinkerLabeled.xml"/>
     <tool file="openms/FeatureLinkerUnlabeled.xml"/>
+    <tool file="openms/FeatureLinkerUnlabeledKD.xml"/>
     <tool file="openms/FeatureLinkerUnlabeledQT.xml"/>
     <tool file="openms/MapRTTransformer.xml"/>
   </section>
@@ -154,9 +154,7 @@
     <tool file="openms/FeatureFinderMultiplex.xml"/>
     <tool file="openms/FeatureFinderSuperHirn.xml"/>
     <tool file="openms/IsobaricAnalyzer.xml"/>
-    <tool file="openms/ITRAQAnalyzer.xml"/>
     <tool file="openms/ProteinQuantifier.xml"/>
     <tool file="openms/ProteinResolver.xml"/>
-    <tool file="openms/TMTAnalyzer.xml"/>
   </section>
 </toolbox>