annotate MapAlignerIdentification.xml @ 2:1f0a9c3cb526 draft

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

<?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: [Map Alignment]-->
<tool id="MapAlignerIdentification" name="MapAlignerIdentification" version="2.3.0">
  <description>Corrects retention time distortions between maps based on common peptide identifications.</description>
  <macros>
    <token name="@EXECUTABLE@">MapAlignerIdentification</token>
    <import>macros.xml</import>
  </macros>
  <expand macro="references"/>
  <expand macro="stdio"/>
  <expand macro="requirements"/>
  <command detect_errors="aggressive"><![CDATA[MapAlignerIdentification

-in
  #for token in $param_in:
    $token
  #end for

#if $rep_param_out:
-out
  #for token in $rep_param_out:
    #if " " in str(token):
      "$token.param_out"
    #else
      $token.param_out
    #end if
  #end for
#end if

#if $rep_param_trafo_out:
-trafo_out
  #for token in $rep_param_trafo_out:
    #if " " in str(token):
      "$token.param_trafo_out"
    #else
      $token.param_trafo_out
    #end if
  #end for
#end if
#if $param_design:
  -design $param_design
#end if
#if $param_reference_file:
  -reference:file $param_reference_file
#end if
#if $param_reference_index:
  -reference:index $param_reference_index
#end if
#if $param_algorithm_min_run_occur:
  -algorithm:min_run_occur $param_algorithm_min_run_occur
#end if
#if $param_algorithm_max_rt_shift:
  -algorithm:max_rt_shift $param_algorithm_max_rt_shift
#end if
#if $param_algorithm_use_unassigned_peptides:
  -algorithm:use_unassigned_peptides
  #if " " in str($param_algorithm_use_unassigned_peptides):
    "$param_algorithm_use_unassigned_peptides"
  #else
    $param_algorithm_use_unassigned_peptides
  #end if
#end if
#if $param_algorithm_use_feature_rt:
  -algorithm:use_feature_rt
#end if
#if $param_model_type:
  -model:type
  #if " " in str($param_model_type):
    "$param_model_type"
  #else
    $param_model_type
  #end if
#end if
#if $param_model_linear_symmetric_regression:
  -model:linear:symmetric_regression
#end if
#if $param_model_b_spline_wavelength:
  -model:b_spline:wavelength $param_model_b_spline_wavelength
#end if
#if $param_model_b_spline_num_nodes:
  -model:b_spline:num_nodes $param_model_b_spline_num_nodes
#end if
#if $param_model_b_spline_extrapolate:
  -model:b_spline:extrapolate
  #if " " in str($param_model_b_spline_extrapolate):
    "$param_model_b_spline_extrapolate"
  #else
    $param_model_b_spline_extrapolate
  #end if
#end if
#if $param_model_b_spline_boundary_condition:
  -model:b_spline:boundary_condition $param_model_b_spline_boundary_condition
#end if
#if $param_model_lowess_span:
  -model:lowess:span $param_model_lowess_span
#end if
#if $param_model_lowess_num_iterations:
  -model:lowess:num_iterations $param_model_lowess_num_iterations
#end if
#if $param_model_lowess_delta:
  -model:lowess:delta $param_model_lowess_delta
#end if
#if $param_model_lowess_interpolation_type:
  -model:lowess:interpolation_type
  #if " " in str($param_model_lowess_interpolation_type):
    "$param_model_lowess_interpolation_type"
  #else
    $param_model_lowess_interpolation_type
  #end if
#end if
#if $param_model_lowess_extrapolation_type:
  -model:lowess:extrapolation_type
  #if " " in str($param_model_lowess_extrapolation_type):
    "$param_model_lowess_extrapolation_type"
  #else
    $param_model_lowess_extrapolation_type
  #end if
#end if
#if $param_model_interpolated_interpolation_type:
  -model:interpolated:interpolation_type
  #if " " in str($param_model_interpolated_interpolation_type):
    "$param_model_interpolated_interpolation_type"
  #else
    $param_model_interpolated_interpolation_type
  #end if
#end if
#if $param_model_interpolated_extrapolation_type:
  -model:interpolated:extrapolation_type
  #if " " in str($param_model_interpolated_extrapolation_type):
    "$param_model_interpolated_extrapolation_type"
  #else
    $param_model_interpolated_extrapolation_type
  #end if
#end if
#if $adv_opts.adv_opts_selector=='advanced':
    #if $adv_opts.param_force:
  -force
#end if
#end if
]]></command>
  <inputs>
    <param name="param_in" type="data" format="featurexml,consensusxml,idxml" multiple="true" optional="False" size="30" label="Input files to align (all must have the same file type)" help="(-in) ">
      <sanitizer>
        <valid initial="string.printable">
          <remove value="'"/>
          <remove value="&quot;"/>
        </valid>
      </sanitizer>
    </param>
    <param name="param_design" type="data" format="tabular" optional="True" label="input file containing the experimental design" help="(-design) "/>
    <param name="param_reference_file" type="data" format="featurexml,consensusxml,idxml" optional="True" label="File to use as reference" help="(-file) "/>
    <param name="param_reference_index" type="integer" min="0" optional="True" value="0" label="Use one of the input files as reference ('1' for the first file, etc.)" help="(-index) &lt;br&gt;If '0', no explicit reference is set - the algorithm will select a reference"/>
    <param name="param_algorithm_min_run_occur" type="integer" min="2" optional="True" value="2" label="Minimum number of runs (incl" help="(-min_run_occur) reference, if any) in which a peptide must occur to be used for the alignment. &lt;br&gt;Unless you have very few runs or identifications, increase this value to focus on more informative peptides"/>
    <param name="param_algorithm_max_rt_shift" type="float" min="0.0" optional="True" value="0.5" label="Maximum realistic RT difference for a peptide (median per run vs" help="(-max_rt_shift) reference). Peptides with higher shifts (outliers) are not used to compute the alignment. &lt;br&gt;If 0, no limit (disable filter); if &gt; 1, the final value in seconds; if &lt;= 1, taken as a fraction of the range of the reference RT scale"/>
    <param name="param_algorithm_use_unassigned_peptides" display="radio" type="select" optional="False" value="true" label="Should unassigned peptide identifications be used when computing an alignment of feature or consensus maps?" help="(-use_unassigned_peptides) If 'false', only peptide IDs assigned to features will be used">
      <option value="true" selected="true">true</option>
      <option value="false">false</option>
    </param>
    <param name="param_algorithm_use_feature_rt" display="radio" type="boolean" truevalue="-algorithm:use_feature_rt" falsevalue="" checked="false" optional="True" label="When aligning feature or consensus maps, don't use the retention time of a peptide identification directly; instead, use the retention time of the centroid of the feature (apex of the elution profile) that the peptide was matched to" help="(-use_feature_rt) If different identifications are matched to one feature, only the peptide closest to the centroid in RT is used. &lt;br&gt;Precludes 'use_unassigned_peptides'"/>
    <param name="param_model_type" display="radio" type="select" optional="False" value="b_spline" label="Type of model" help="(-type) ">
      <option value="linear">linear</option>
      <option value="b_spline" selected="true">b_spline</option>
      <option value="lowess">lowess</option>
      <option value="interpolated">interpolated</option>
    </param>
    <param name="param_model_linear_symmetric_regression" display="radio" type="boolean" truevalue="-model:linear:symmetric_regression" falsevalue="" checked="false" optional="True" label="Perform linear regression on 'y - x' vs" help="(-symmetric_regression) 'y + x', instead of on 'y' vs. 'x'"/>
    <param name="param_model_b_spline_wavelength" type="float" min="0.0" optional="True" value="0.0" label="Determines the amount of smoothing by setting the number of nodes for the B-spline" help="(-wavelength) The number is chosen so that the spline approximates a low-pass filter with this cutoff wavelength. The wavelength is given in the same units as the data; a higher value means more smoothing. '0' sets the number of nodes to twice the number of input points"/>
    <param name="param_model_b_spline_num_nodes" type="integer" min="0" optional="True" value="5" label="Number of nodes for B-spline fitting" help="(-num_nodes) Overrides 'wavelength' if set (to two or greater). A lower value means more smoothing"/>
    <param name="param_model_b_spline_extrapolate" display="radio" type="select" optional="False" value="linear" label="Method to use for extrapolation beyond the original data range" help="(-extrapolate) 'linear': Linear extrapolation using the slope of the B-spline at the corresponding endpoint. 'b_spline': Use the B-spline (as for interpolation). 'constant': Use the constant value of the B-spline at the corresponding endpoint. 'global_linear': Use a linear fit through the data (which will most probably introduce discontinuities at the ends of the data range)">
      <option value="linear" selected="true">linear</option>
      <option value="b_spline">b_spline</option>
      <option value="constant">constant</option>
      <option value="global_linear">global_linear</option>
    </param>
    <param name="param_model_b_spline_boundary_condition" type="integer" min="0" max="2" optional="True" value="2" label="Boundary condition at B-spline endpoints: 0 (value zero), 1 (first derivative zero) or 2 (second derivative zero)" help="(-boundary_condition) "/>
    <param name="param_model_lowess_span" type="float" min="0.0" max="1.0" optional="True" value="0.666666666667" label="Fraction of datapoints (f) to use for each local regression (determines the amount of smoothing)" help="(-span) Choosing this parameter in the range .2 to .8 usually results in a good fit"/>
    <param name="param_model_lowess_num_iterations" type="integer" min="0" optional="True" value="3" label="Number of robustifying iterations for lowess fitting" help="(-num_iterations) "/>
    <param name="param_model_lowess_delta" type="float" value="-1.0" label="Nonnegative parameter which may be used to save computations (recommended value is 0.01 of the range of the input," help="(-delta) e.g. for data ranging from 1000 seconds to 2000 seconds, it could be set to 10). Setting a negative value will automatically do this"/>
    <param name="param_model_lowess_interpolation_type" display="radio" type="select" optional="False" value="cspline" label="Method to use for interpolation between datapoints computed by lowess" help="(-interpolation_type) 'linear': Linear interpolation. 'cspline': Use the cubic spline for interpolation. 'akima': Use an akima spline for interpolation">
      <option value="linear">linear</option>
      <option value="cspline" selected="true">cspline</option>
      <option value="akima">akima</option>
    </param>
    <param name="param_model_lowess_extrapolation_type" display="radio" type="select" optional="False" value="four-point-linear" label="Method to use for extrapolation outside the data range" help="(-extrapolation_type) 'two-point-linear': Uses a line through the first and last point to extrapolate. 'four-point-linear': Uses a line through the first and second point to extrapolate in front and and a line through the last and second-to-last point in the end. 'global-linear': Uses a linear regression to fit a line through all data points and use it for interpolation">
      <option value="two-point-linear">two-point-linear</option>
      <option value="four-point-linear" selected="true">four-point-linear</option>
      <option value="global-linear">global-linear</option>
    </param>
    <param name="param_model_interpolated_interpolation_type" display="radio" type="select" optional="False" value="cspline" label="Type of interpolation to apply" help="(-interpolation_type) ">
      <option value="linear">linear</option>
      <option value="cspline" selected="true">cspline</option>
      <option value="akima">akima</option>
    </param>
    <param name="param_model_interpolated_extrapolation_type" display="radio" type="select" optional="False" value="two-point-linear" label="Type of extrapolation to apply: two-point-linear: use the first and last data point to build a single linear model, four-point-linear: build two linear models on both ends using the first two / last two points, global-linear: use all points to build a single linear model" help="(-extrapolation_type) Note that global-linear may not be continuous at the border">
      <option value="two-point-linear" selected="true">two-point-linear</option>
      <option value="four-point-linear">four-point-linear</option>
      <option value="global-linear">global-linear</option>
    </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) "/>
    </expand>
  </inputs>
  <outputs>
    <data name="param_out" metadata_source="param_in" format="input"/>
    <data name="param_trafo_out" format="trafoxml"/>
  </outputs>
  <help>Corrects retention time distortions between maps based on common peptide identifications.


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