annotate MetaboliteAdductDecharger.xml @ 3:65db7655c6a2 draft

planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit f608f41d45664d04d3124c6ebc791bf8a566b3c5-dirty

<?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="MetaboliteAdductDecharger" name="MetaboliteAdductDecharger" version="2.3.0">
  <description>Decharges and merges different feature charge variants of the same metabolite.</description>
  <macros>
    <token name="@EXECUTABLE@">MetaboliteAdductDecharger</token>
    <import>macros.xml</import>
  </macros>
  <expand macro="references"/>
  <expand macro="stdio"/>
  <expand macro="requirements"/>
  <command detect_errors="aggressive"><![CDATA[MetaboliteAdductDecharger

#if $param_in:
  -in $param_in
#end if
#if $param_out_cm:
  -out_cm $param_out_cm
#end if
#if $param_out_fm:
  -out_fm $param_out_fm
#end if
#if $param_outpairs:
  -outpairs $param_outpairs
#end if
#if $param_algorithm_MetaboliteFeatureDeconvolution_charge_min:
  -algorithm:MetaboliteFeatureDeconvolution:charge_min $param_algorithm_MetaboliteFeatureDeconvolution_charge_min
#end if
#if $param_algorithm_MetaboliteFeatureDeconvolution_charge_max:
  -algorithm:MetaboliteFeatureDeconvolution:charge_max $param_algorithm_MetaboliteFeatureDeconvolution_charge_max
#end if
#if $param_algorithm_MetaboliteFeatureDeconvolution_charge_span_max:
  -algorithm:MetaboliteFeatureDeconvolution:charge_span_max $param_algorithm_MetaboliteFeatureDeconvolution_charge_span_max
#end if
#if $param_algorithm_MetaboliteFeatureDeconvolution_q_try:
  -algorithm:MetaboliteFeatureDeconvolution:q_try
  #if " " in str($param_algorithm_MetaboliteFeatureDeconvolution_q_try):
    "$param_algorithm_MetaboliteFeatureDeconvolution_q_try"
  #else
    $param_algorithm_MetaboliteFeatureDeconvolution_q_try
  #end if
#end if
#if $param_algorithm_MetaboliteFeatureDeconvolution_retention_max_diff:
  -algorithm:MetaboliteFeatureDeconvolution:retention_max_diff $param_algorithm_MetaboliteFeatureDeconvolution_retention_max_diff
#end if
#if $param_algorithm_MetaboliteFeatureDeconvolution_retention_max_diff_local:
  -algorithm:MetaboliteFeatureDeconvolution:retention_max_diff_local $param_algorithm_MetaboliteFeatureDeconvolution_retention_max_diff_local
#end if
#if $param_algorithm_MetaboliteFeatureDeconvolution_mass_max_diff:
  -algorithm:MetaboliteFeatureDeconvolution:mass_max_diff $param_algorithm_MetaboliteFeatureDeconvolution_mass_max_diff
#end if

#if $rep_param_algorithm_MetaboliteFeatureDeconvolution_potential_adducts:
-algorithm:MetaboliteFeatureDeconvolution:potential_adducts
  #for token in $rep_param_algorithm_MetaboliteFeatureDeconvolution_potential_adducts:
    #if " " in str(token):
      "$token.param_algorithm_MetaboliteFeatureDeconvolution_potential_adducts"
    #else
      $token.param_algorithm_MetaboliteFeatureDeconvolution_potential_adducts
    #end if
  #end for
#end if
#if $param_algorithm_MetaboliteFeatureDeconvolution_max_neutrals:
  -algorithm:MetaboliteFeatureDeconvolution:max_neutrals $param_algorithm_MetaboliteFeatureDeconvolution_max_neutrals
#end if
#if $param_algorithm_MetaboliteFeatureDeconvolution_max_minority_bound:
  -algorithm:MetaboliteFeatureDeconvolution:max_minority_bound $param_algorithm_MetaboliteFeatureDeconvolution_max_minority_bound
#end if
#if $param_algorithm_MetaboliteFeatureDeconvolution_min_rt_overlap:
  -algorithm:MetaboliteFeatureDeconvolution:min_rt_overlap $param_algorithm_MetaboliteFeatureDeconvolution_min_rt_overlap
#end if
#if $param_algorithm_MetaboliteFeatureDeconvolution_intensity_filter:
  -algorithm:MetaboliteFeatureDeconvolution:intensity_filter
#end if
#if $param_algorithm_MetaboliteFeatureDeconvolution_negative_mode:
  -algorithm:MetaboliteFeatureDeconvolution:negative_mode     "$param_algorithm_MetaboliteFeatureDeconvolution_negative_mode"
#end if
#if $adv_opts.adv_opts_selector=='advanced':
    #if $adv_opts.param_force:
  -force
#end if
    #if $adv_opts.param_algorithm_MetaboliteFeatureDeconvolution_default_map_label:
  -algorithm:MetaboliteFeatureDeconvolution:default_map_label     "$adv_opts.param_algorithm_MetaboliteFeatureDeconvolution_default_map_label"
#end if
    #if $adv_opts.param_algorithm_MetaboliteFeatureDeconvolution_verbose_level:
  -algorithm:MetaboliteFeatureDeconvolution:verbose_level $adv_opts.param_algorithm_MetaboliteFeatureDeconvolution_verbose_level
#end if
#end if
]]></command>
  <inputs>
    <param name="param_in" type="data" format="featurexml" optional="False" label="input file" help="(-in) "/>
    <param name="param_algorithm_MetaboliteFeatureDeconvolution_charge_min" type="integer" value="1" label="Minimal possible charge" help="(-charge_min) "/>
    <param name="param_algorithm_MetaboliteFeatureDeconvolution_charge_max" type="integer" value="3" label="Maximal possible charge" help="(-charge_max) "/>
    <param name="param_algorithm_MetaboliteFeatureDeconvolution_charge_span_max" type="integer" min="1" optional="True" value="3" label="Maximal range of charges for a single analyte, i.e" help="(-charge_span_max) observing q1=[5,6,7] implies span=3. Setting this to 1 will only find adduct variants of the same charge"/>
    <param name="param_algorithm_MetaboliteFeatureDeconvolution_q_try" display="radio" type="select" optional="False" value="feature" label="Try different values of charge for each feature according to the above settings ('heuristic' [does not test all charges, just the likely ones] or 'all' ), or leave feature charge untouched ('feature')" help="(-q_try) ">
      <option value="feature" selected="true">feature</option>
      <option value="heuristic">heuristic</option>
      <option value="all">all</option>
    </param>
    <param name="param_algorithm_MetaboliteFeatureDeconvolution_retention_max_diff" type="float" value="1.0" label="Maximum allowed RT difference between any two features if their relation shall be determined" help="(-retention_max_diff) "/>
    <param name="param_algorithm_MetaboliteFeatureDeconvolution_retention_max_diff_local" type="float" value="1.0" label="Maximum allowed RT difference between between two co-features, after adduct shifts have been accounted for (if you do not have any adduct shifts, this value should be equal to 'retention_max_diff', otherwise it should be smaller!)" help="(-retention_max_diff_local) "/>
    <param name="param_algorithm_MetaboliteFeatureDeconvolution_mass_max_diff" type="float" value="0.05" label="Maximum allowed mass difference [in Th] for a single feature" help="(-mass_max_diff) "/>
    <repeat name="rep_param_algorithm_MetaboliteFeatureDeconvolution_potential_adducts" min="0" max="1" title="param_algorithm_MetaboliteFeatureDeconvolution_potential_adducts">
      <param name="param_algorithm_MetaboliteFeatureDeconvolution_potential_adducts" type="text" size="30" value="K:+:0.1" label="Adducts used to explain mass differences in format: 'Element:Charge(+/-):Probability[:RTShift[:Label]]', i.e. the number of '+' or '-' indicate the charge," help="(-potential_adducts) e.g. 'Ca:++:0.5' indicates +2. Probabilites have to be in (0,1]. RTShift param is optional and indicates the expected RT shift caused by this adduct, e.g. '(2)H4H-4:0:1:-3' indicates a 4 deuterium label, which causes early elution by 3 seconds. As a fifth parameter you can add a label which is tagged on every feature which has this adduct. This also determines the map number in the consensus file">
        <sanitizer>
          <valid initial="string.printable">
            <remove value="'"/>
            <remove value="&quot;"/>
          </valid>
        </sanitizer>
      </param>
    </repeat>
    <param name="param_algorithm_MetaboliteFeatureDeconvolution_max_neutrals" type="integer" value="0" label="Maximal number of neutral adducts(q=0) allowed" help="(-max_neutrals) Add them in the 'potential_adducts' section!"/>
    <param name="param_algorithm_MetaboliteFeatureDeconvolution_max_minority_bound" type="integer" min="0" optional="True" value="2" label="Maximum count of the least probable adduct (according to 'potential_adducts' param) within a charge variant" help="(-max_minority_bound) E.g. setting this to 2 will not allow an adduct composition of '1(H+),3(Na+)' if Na+ is the least probable adduct"/>
    <param name="param_algorithm_MetaboliteFeatureDeconvolution_min_rt_overlap" type="float" min="0.0" max="1.0" optional="True" value="0.66" label="Minimum overlap of the convex hull' RT intersection measured against the union from two features (if CHs are given)" help="(-min_rt_overlap) "/>
    <param name="param_algorithm_MetaboliteFeatureDeconvolution_intensity_filter" display="radio" type="boolean" truevalue="-algorithm:MetaboliteFeatureDeconvolution:intensity_filter" falsevalue="" checked="false" optional="True" label="Enable the intensity filter, which will only allow edges between two equally charged features if the intensity of the feature with less likely adducts is smaller than that of the other feature" help="(-intensity_filter) It is not used for features of different charge"/>
    <param name="param_algorithm_MetaboliteFeatureDeconvolution_negative_mode" type="text" size="30" value="false" label="Enable negative ionization mode" help="(-negative_mode) ">
      <sanitizer>
        <valid initial="string.printable">
          <remove value="'"/>
          <remove value="&quot;"/>
        </valid>
      </sanitizer>
    </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_MetaboliteFeatureDeconvolution_default_map_label" type="text" size="30" value="decharged features" label="Label of map in output consensus file where all features are put by default" help="(-default_map_label) ">
        <sanitizer>
          <valid initial="string.printable">
            <remove value="'"/>
            <remove value="&quot;"/>
          </valid>
        </sanitizer>
      </param>
      <param name="param_algorithm_MetaboliteFeatureDeconvolution_verbose_level" type="integer" min="0" max="3" optional="True" value="0" label="Amount of debug information given during processing" help="(-verbose_level) "/>
    </expand>
  </inputs>
  <outputs>
    <data name="param_out_cm" format="consensusxml"/>
    <data name="param_out_fm" format="featurexml"/>
    <data name="param_outpairs" format="consensusxml"/>
  </outputs>
  <help>Decharges and merges different feature charge variants of the same metabolite.


For more information, visit https://abibuilder.informatik.uni-tuebingen.de/archive/openms/Documentation/release/2.3.0/html/UTILS_MetaboliteAdductDecharger.html</help>
</tool>