changeset 3:13bfce690403 draft

planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit daf6dfc513ede9b890125d9fff2c2657d834eea9
author galaxyp
date Fri, 14 Jul 2017 19:06:58 -0400
parents 20ac794a6fb5
children 415f25263c4d
files OpenSwathRTNormalizer.xml macros.xml readme.md tool.conf
diffstat 4 files changed, 40 insertions(+), 34 deletions(-) [+]
line wrap: on
line diff
--- a/OpenSwathRTNormalizer.xml	Thu Apr 27 13:03:41 2017 -0400
+++ b/OpenSwathRTNormalizer.xml	Fri Jul 14 19:06:58 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: [Targeted Experiments]-->
-<tool id="OpenSwathRTNormalizer" name="OpenSwathRTNormalizer" version="2.1.0">
+<tool id="OpenSwathRTNormalizer" name="OpenSwathRTNormalizer" version="2.2.0">
   <description>This tool will take a description of RT peptides and their normalized retention time to write out a transformation file on how to transform the RT space into the normalized space.</description>
   <macros>
     <token name="@EXECUTABLE@">OpenSwathRTNormalizer</token>
@@ -187,7 +187,10 @@
   #end if
 #end if
     #if $adv_opts.param_algorithm_TransitionGroupPicker_recalculate_peaks:
-  -algorithm:TransitionGroupPicker:recalculate_peaks     "$adv_opts.param_algorithm_TransitionGroupPicker_recalculate_peaks"
+  -algorithm:TransitionGroupPicker:recalculate_peaks
+#end if
+    #if $adv_opts.param_algorithm_TransitionGroupPicker_use_precursors:
+  -algorithm:TransitionGroupPicker:use_precursors
 #end if
     #if $adv_opts.param_algorithm_TransitionGroupPicker_recalculate_peaks_max_z:
   -algorithm:TransitionGroupPicker:recalculate_peaks_max_z $adv_opts.param_algorithm_TransitionGroupPicker_recalculate_peaks_max_z
@@ -196,7 +199,7 @@
   -algorithm:TransitionGroupPicker:minimal_quality $adv_opts.param_algorithm_TransitionGroupPicker_minimal_quality
 #end if
     #if $adv_opts.param_algorithm_TransitionGroupPicker_compute_peak_quality:
-  -algorithm:TransitionGroupPicker:compute_peak_quality     "$adv_opts.param_algorithm_TransitionGroupPicker_compute_peak_quality"
+  -algorithm:TransitionGroupPicker:compute_peak_quality
 #end if
     #if $adv_opts.param_algorithm_EMGScoring_interpolation_step:
   -algorithm:EMGScoring:interpolation_step $adv_opts.param_algorithm_EMGScoring_interpolation_step
@@ -296,6 +299,9 @@
     #if $adv_opts.param_algorithm_Scores_use_ms1_correlation:
   -algorithm:Scores:use_ms1_correlation
 #end if
+    #if $adv_opts.param_algorithm_Scores_use_sonar_scores:
+  -algorithm:Scores:use_sonar_scores
+#end if
     #if $adv_opts.param_algorithm_Scores_use_ms1_fullscan:
   -algorithm:Scores:use_ms1_fullscan
 #end if
@@ -380,24 +386,11 @@
         <option value="smoothed">smoothed</option>
         <option value="original">original</option>
       </param>
-      <param name="param_algorithm_TransitionGroupPicker_recalculate_peaks" type="text" size="30" value="false" label="Tries to get better peak picking by looking at peak consistency of all picked peaks" help="(-recalculate_peaks) Tries to use the consensus (median) peak border if theof variation within the picked peaks is too large">
-        <sanitizer>
-          <valid initial="string.printable">
-            <remove value="'"/>
-            <remove value="&quot;"/>
-          </valid>
-        </sanitizer>
-      </param>
+      <param name="param_algorithm_TransitionGroupPicker_recalculate_peaks" display="radio" type="boolean" truevalue="-algorithm:TransitionGroupPicker:recalculate_peaks" falsevalue="" checked="false" optional="True" label="Tries to get better peak picking by looking at peak consistency of all picked peaks" help="(-recalculate_peaks) Tries to use the consensus (median) peak border if theof variation within the picked peaks is too large"/>
+      <param name="param_algorithm_TransitionGroupPicker_use_precursors" display="radio" type="boolean" truevalue="-algorithm:TransitionGroupPicker:use_precursors" falsevalue="" checked="false" optional="True" label="Use precursor chromatogram for peak picking" help="(-use_precursors) "/>
       <param name="param_algorithm_TransitionGroupPicker_recalculate_peaks_max_z" type="float" value="1.0" label="Determines the maximal Z-Score (difference measured in standard deviations) that is considered too large for peak boundaries" help="(-recalculate_peaks_max_z) If the Z-Score is above this value, the median is used for peak boundaries (default value 1.0)"/>
       <param name="param_algorithm_TransitionGroupPicker_minimal_quality" type="float" value="-10000.0" label="Only if compute_peak_quality is set, this parameter will not consider peaks below this quality threshold" help="(-minimal_quality) "/>
-      <param name="param_algorithm_TransitionGroupPicker_compute_peak_quality" type="text" size="30" value="false" label="Tries to compute a quality value for each peakgroup and detect outlier transitions" help="(-compute_peak_quality) The resulting score is centered around zero and values above 0 are generally good and below -1 or -2 are usually bad">
-        <sanitizer>
-          <valid initial="string.printable">
-            <remove value="'"/>
-            <remove value="&quot;"/>
-          </valid>
-        </sanitizer>
-      </param>
+      <param name="param_algorithm_TransitionGroupPicker_compute_peak_quality" display="radio" type="boolean" truevalue="-algorithm:TransitionGroupPicker:compute_peak_quality" falsevalue="" checked="false" optional="True" label="Tries to compute a quality value for each peakgroup and detect outlier transitions" help="(-compute_peak_quality) The resulting score is centered around zero and values above 0 are generally good and below -1 or -2 are usually bad"/>
       <param name="param_algorithm_EMGScoring_interpolation_step" type="float" value="0.2" label="Sampling rate for the interpolation of the model function" help="(-interpolation_step) "/>
       <param name="param_algorithm_EMGScoring_tolerance_stdev_bounding_box" type="float" value="3.0" label="Bounding box has range [minimim of data, maximum of data] enlarged by tolerance_stdev_bounding_box times the standard deviation of the data" help="(-tolerance_stdev_bounding_box) "/>
       <param name="param_algorithm_EMGScoring_max_iteration" type="integer" value="500" label="Maximum number of iterations using by Levenberg-Marquardt algorithm" help="(-max_iteration) "/>
@@ -439,11 +432,12 @@
         <option value="true" selected="true">true</option>
         <option value="false">false</option>
       </param>
-      <param name="param_algorithm_Scores_use_dia_scores" display="radio" type="select" optional="False" value="true" label="Use the DIA (SWATH) scores" help="(-use_dia_scores) ">
+      <param name="param_algorithm_Scores_use_dia_scores" display="radio" type="select" optional="False" value="true" label="Use the DIA (SWATH) scores" help="(-use_dia_scores) If turned off, will not use fragment ion spectra for scoring">
         <option value="true" selected="true">true</option>
         <option value="false">false</option>
       </param>
       <param name="param_algorithm_Scores_use_ms1_correlation" display="radio" type="boolean" truevalue="-algorithm:Scores:use_ms1_correlation" falsevalue="" checked="false" optional="True" label="Use the correlation scores with the MS1 elution profiles" help="(-use_ms1_correlation) "/>
+      <param name="param_algorithm_Scores_use_sonar_scores" display="radio" type="boolean" truevalue="-algorithm:Scores:use_sonar_scores" falsevalue="" checked="false" optional="True" label="Use the scores for SONAR scans (scanning swath)" help="(-use_sonar_scores) "/>
       <param name="param_algorithm_Scores_use_ms1_fullscan" display="radio" type="boolean" truevalue="-algorithm:Scores:use_ms1_fullscan" falsevalue="" checked="false" optional="True" label="Use the full MS1 scan at the peak apex for scoring (ppm accuracy of precursor and isotopic pattern)" help="(-use_ms1_fullscan) "/>
       <param name="param_algorithm_Scores_use_uis_scores" display="radio" type="boolean" truevalue="-algorithm:Scores:use_uis_scores" falsevalue="" checked="false" optional="True" label="Use UIS scores for peptidoform identification" help="(-use_uis_scores) "/>
     </expand>
--- a/macros.xml	Thu Apr 27 13:03:41 2017 -0400
+++ b/macros.xml	Fri Jul 14 19:06:58 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	Thu Apr 27 13:03:41 2017 -0400
+++ b/readme.md	Fri Jul 14 19:06:58 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
 
@@ -42,7 +56,7 @@
     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. The default files are provided in this repository.
+ * 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 \ 
--- a/tool.conf	Thu Apr 27 13:03:41 2017 -0400
+++ b/tool.conf	Fri Jul 14 19:06:58 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>