annotate SiriusAdapter.xml @ 7:d784e23cc91c draft

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

<?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: [Utilities]-->
<tool id="SiriusAdapter" name="SiriusAdapter" version="@TOOL_VERSION@+galaxy@GALAXY_VERSION@" profile="20.05">
  <description>Tool for metabolite identification using single and tandem mass spectrometry</description>
  <macros>
    <token name="@EXECUTABLE@">SiriusAdapter</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)' &&
#if $in_featureinfo:
  mkdir in_featureinfo &&
  ln -s '$in_featureinfo' 'in_featureinfo/${re.sub("[^\w\-_]", "_", $in_featureinfo.element_identifier)}.$gxy2omsext($in_featureinfo.ext)' &&
#end if
#if "out_sirius_FLAG" in str($OPTIONAL_OUTPUTS).split(',')
  mkdir out_sirius &&
#end if
#if "out_fingerid_FLAG" in str($OPTIONAL_OUTPUTS).split(',')
  mkdir out_fingerid &&
#end if
#if "out_ms_FLAG" in str($OPTIONAL_OUTPUTS).split(',')
  mkdir out_ms &&
#end if

## 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)'
#if $in_featureinfo:
  -in_featureinfo
  'in_featureinfo/${re.sub("[^\w\-_]", "_", $in_featureinfo.element_identifier)}.$gxy2omsext($in_featureinfo.ext)'
#end if
#if "out_sirius_FLAG" in str($OPTIONAL_OUTPUTS).split(',')
  -out_sirius
  'out_sirius/output.${gxy2omsext("mztab")}'
#end if
#if "out_fingerid_FLAG" in str($OPTIONAL_OUTPUTS).split(',')
  -out_fingerid
  'out_fingerid/output.${gxy2omsext("mztab")}'
#end if
#if "out_ms_FLAG" in str($OPTIONAL_OUTPUTS).split(',')
  -out_ms
  'out_ms/output.${gxy2omsext("sirius.ms")}'
#end if
#if len(str($OPTIONAL_OUTPUTS).split(',')) == 0
  | tee '$stdout'
#end if

## Postprocessing
#if "out_sirius_FLAG" in str($OPTIONAL_OUTPUTS).split(',')
  && mv 'out_sirius/output.${gxy2omsext("mztab")}' '$out_sirius'
#end if
#if "out_fingerid_FLAG" in str($OPTIONAL_OUTPUTS).split(',')
  && mv 'out_fingerid/output.${gxy2omsext("mztab")}' '$out_fingerid'
#end if
#if "out_ms_FLAG" in str($OPTIONAL_OUTPUTS).split(',')
  && mv 'out_ms/output.${gxy2omsext("sirius.ms")}' '$out_ms'
#end if
#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[{"executable": "\$(which sirius)", "log": "log.txt", "threads": "\${GALAXY_SLOTS:-1}", "no_progress": true, "sirius": {"cores": "\${GALAXY_SLOTS:-1}"}}]]></configfile>
  </configfiles>
  <inputs>
    <param name="in" argument="-in" type="data" format="mzml" optional="false" label="MzML Input file" help=" select mzml data sets(s)"/>
    <param name="in_featureinfo" argument="-in_featureinfo" type="data" format="featurexml" optional="true" label="FeatureXML input with feature and adduct information" help=" select featurexml data sets(s)"/>
    <param name="out_workspace_directory" argument="-out_workspace_directory" type="text" optional="true" value="" label="Output directory for SIRIUS workspace" help="">
      <expand macro="list_string_san"/>
    </param>
    <section name="preprocessing" title="Preprocessing" help="" expanded="false">
      <param name="filter_by_num_masstraces" argument="-preprocessing:filter_by_num_masstraces" type="integer" optional="true" min="1" value="1" label="Features have to have at least x MassTraces" help="To use this parameter feature_only is neccessary"/>
      <param name="precursor_mz_tolerance" argument="-preprocessing:precursor_mz_tolerance" type="float" optional="true" value="0.005" label="Tolerance window for precursor selection (Feature selection in regard to the precursor)" help=""/>
      <param name="precursor_mz_tolerance_unit" argument="-preprocessing:precursor_mz_tolerance_unit" display="radio" type="select" optional="false" label="Unit of the precursor_mz_tolerance" help="">
        <option value="Da" selected="true">Da</option>
        <option value="ppm">ppm</option>
        <expand macro="list_string_san"/>
      </param>
      <param name="precursor_rt_tolerance" argument="-preprocessing:precursor_rt_tolerance" type="integer" optional="true" value="5" label="Tolerance window (left and right) for precursor selection [seconds]" help=""/>
      <param name="isotope_pattern_iterations" argument="-preprocessing:isotope_pattern_iterations" type="integer" optional="true" value="3" label="Number of iterations that should be performed to extract the C13 isotope pattern" help="If no peak is found (C13 distance) the function will abort. Be careful with noisy data - since this can lead to wrong isotope patterns"/>
      <param name="feature_only" argument="-preprocessing:feature_only" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Uses the feature information from in_featureinfo to reduce the search space to MS2 associated with a feature" help=""/>
      <param name="no_masstrace_info_isotope_pattern" argument="-preprocessing:no_masstrace_info_isotope_pattern" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Use this flag if the masstrace information from a feature should be discarded and the isotope_pattern_iterations should be used instead" help=""/>
    </section>
    <section name="sirius" title="Parameters for SIRIUS and CSI:FingerID" help="" expanded="false">
      <param name="profile" argument="-sirius:profile" display="radio" type="select" optional="false" label="Specify the used analysis profile" help="">
        <option value="qtof" selected="true">qtof</option>
        <option value="orbitrap">orbitrap</option>
        <option value="fticr">fticr</option>
        <expand macro="list_string_san"/>
      </param>
      <param name="candidates" argument="-sirius:candidates" type="integer" optional="true" min="1" value="5" label="The number of candidates in the SIRIUS output" help=""/>
      <param name="database" argument="-sirius:database" type="select" optional="false" label="search formulas in given database" help="">
        <option value="all" selected="true">all</option>
        <option value="chebi">chebi</option>
        <option value="custom">custom</option>
        <option value="kegg">kegg</option>
        <option value="bio">bio</option>
        <option value="natural products">natural products</option>
        <option value="pubmed">pubmed</option>
        <option value="hmdb">hmdb</option>
        <option value="biocyc">biocyc</option>
        <option value="hsdb">hsdb</option>
        <option value="knapsack">knapsack</option>
        <option value="biological">biological</option>
        <option value="zinc bio">zinc bio</option>
        <option value="gnps">gnps</option>
        <option value="pubchem">pubchem</option>
        <option value="mesh">mesh</option>
        <option value="maconda">maconda</option>
        <expand macro="list_string_san"/>
      </param>
      <param name="noise" argument="-sirius:noise" type="integer" optional="true" min="0" value="0" label="median intensity of noise peaks" help=""/>
      <param name="ppm_max" argument="-sirius:ppm_max" type="integer" optional="true" value="10" label="allowed ppm for decomposing masses" help=""/>
      <param name="isotope" argument="-sirius:isotope" display="radio" type="select" optional="false" label="how to handle isotope pattern data" help="Use 'score' to use them for ranking or 'filter' if you just want to remove candidates with bad isotope pattern. With 'both' you can use isotopes for filtering and scoring. Use 'omit' to ignore isotope pattern">
        <option value="score">score</option>
        <option value="filter">filter</option>
        <option value="both" selected="true">both</option>
        <option value="omit">omit</option>
        <expand macro="list_string_san"/>
      </param>
      <param name="elements" argument="-sirius:elements" type="text" optional="true" value="CHNOP[5]S[8]Cl[1]" label="The allowed elements" help="Write CHNOPSCl to allow the elements C, H, N, O, P, S and Cl. Add numbers in brackets to restrict the maximal allowed occurrence of these elements: CHNOP[5]S[8]Cl[1]">
        <expand macro="list_string_san"/>
      </param>
      <param name="compound_timeout" argument="-sirius:compound_timeout" type="integer" optional="true" min="0" value="10" label="Time out in seconds per compound" help="To disable the timeout set the value to 0"/>
      <param name="tree_timeout" argument="-sirius:tree_timeout" type="integer" optional="true" min="0" value="0" label="Time out in seconds per fragmentation tree computation" help=""/>
      <param name="top_n_hits" argument="-sirius:top_n_hits" type="integer" optional="true" min="1" value="10" label="The number of top hits for each compound written to the CSI:FingerID output" help=""/>
      <param name="auto_charge" argument="-sirius:auto_charge" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Use this option if the charge of your compounds is unknown and you do not want to assume [M+H]+ as default" help="With the auto charge option SIRIUS will not care about charges and allow arbitrary adducts for the precursor peak"/>
      <param name="ion_tree" argument="-sirius:ion_tree" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Print molecular formulas and node labels with the ion formula instead of the neutral formula" help=""/>
      <param name="no_recalibration" argument="-sirius:no_recalibration" type="boolean" truevalue="true" falsevalue="false" checked="false" label="If this option is set, SIRIUS will not recalibrate the spectrum during the analysis" help=""/>
      <param name="most_intense_ms2" argument="-sirius:most_intense_ms2" type="boolean" truevalue="true" falsevalue="false" checked="false" label="SIRIUS uses the fragmentation spectrum with the most intense precursor peak (for each spectrum)" help=""/>
    </section>
    <expand macro="adv_opts_macro">
      <param name="converter_mode" argument="-converter_mode" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Use this flag in combination with the out_ms file to only convert the input mzML and featureXML to an .ms file" help="Without further SIRIUS processing"/>
      <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="out_sirius_FLAG">out_sirius (MzTab Output file for SiriusAdapter results)</option>
      <option value="out_fingerid_FLAG">out_fingerid (MzTab output file for CSI:FingerID, if this parameter is given, SIRIUS will search for a molecular structure using CSI:FingerID after determining the sum formula)</option>
      <option value="out_ms_FLAG">out_ms (Internal SIRIUS .ms format after OpenMS preprocessing)</option>
      <option value="ctd_out_FLAG">Output used ctd (ini) configuration file</option>
    </param>
  </inputs>
  <outputs>
    <data name="out_sirius" label="${tool.name} on ${on_string}: out_sirius" format="mztab">
      <filter>OPTIONAL_OUTPUTS is not None and "out_sirius_FLAG" in OPTIONAL_OUTPUTS</filter>
    </data>
    <data name="out_fingerid" label="${tool.name} on ${on_string}: out_fingerid" format="mztab">
      <filter>OPTIONAL_OUTPUTS is not None and "out_fingerid_FLAG" in OPTIONAL_OUTPUTS</filter>
    </data>
    <data name="out_ms" label="${tool.name} on ${on_string}: out_ms" format="sirius.ms">
      <filter>OPTIONAL_OUTPUTS is not None and "out_ms_FLAG" in OPTIONAL_OUTPUTS</filter>
    </data>
    <data name="stdout" format="txt" label="${tool.name} on ${on_string}: stdout">
      <filter>OPTIONAL_OUTPUTS is None</filter>
    </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>
  <tests>
    <expand macro="autotest_SiriusAdapter"/>
    <expand macro="manutest_SiriusAdapter"/>
  </tests>
  <help><![CDATA[Tool for metabolite identification using single and tandem mass spectrometry


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