view ctd/MapAlignerPoseClustering.ctd @ 18:6daaa75ccb99 draft

"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
author galaxyp
date Sun, 13 Dec 2020 15:03:50 +0000
parents
children
line wrap: on
line source

<?xml version="1.0" encoding="UTF-8"?>
<tool ctdVersion="1.7" version="2.6.0-pre-exported-20201001" name="MapAlignerPoseClustering" docurl="http://www.openms.de/documentation/TOPP_MapAlignerPoseClustering.html" category="Map Alignment" >
<description><![CDATA[Corrects retention time distortions between maps using a pose clustering approach.]]></description>
<manual><![CDATA[Corrects retention time distortions between maps using a pose clustering approach.]]></manual>
<citations>
  <citation doi="10.1038/nmeth.3959" url="" />
</citations>
<PARAMETERS version="1.7.0" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/OpenMS/OpenMS/develop/share/OpenMS/SCHEMAS/Param_1_7_0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <NODE name="MapAlignerPoseClustering" description="Corrects retention time distortions between maps using a pose clustering approach.">
    <ITEM name="version" value="2.6.0-pre-exported-20201001" type="string" description="Version of the tool that generated this parameters file." required="false" advanced="true" />
    <NODE name="1" description="Instance &apos;1&apos; section for &apos;MapAlignerPoseClustering&apos;">
      <ITEMLIST name="in" type="input-file" description="Input files to align (all must have the same file type)" required="true" advanced="false" supported_formats="*.featureXML,*.mzML">
      </ITEMLIST>
      <ITEMLIST name="out" type="output-file" description="Output files (same file type as &apos;in&apos;). This option or &apos;trafo_out&apos; has to be provided; they can be used together." required="false" advanced="false" supported_formats="*.featureXML,*.mzML">
      </ITEMLIST>
      <ITEMLIST name="trafo_out" type="output-file" description="Transformation output files. This option or &apos;out&apos; has to be provided; they can be used together." required="false" advanced="false" supported_formats="*.trafoXML">
      </ITEMLIST>
      <ITEM name="log" value="" type="string" description="Name of log file (created only when specified)" required="false" advanced="true" />
      <ITEM name="debug" value="0" type="int" description="Sets the debug level" required="false" advanced="true" />
      <ITEM name="threads" value="1" type="int" description="Sets the number of threads allowed to be used by the TOPP tool" required="false" advanced="false" />
      <ITEM name="no_progress" value="false" type="bool" description="Disables progress logging to command line" required="false" advanced="true" />
      <ITEM name="force" value="false" type="bool" description="Overrides tool-specific checks" required="false" advanced="true" />
      <ITEM name="test" value="false" type="bool" description="Enables the test mode (needed for internal use only)" required="false" advanced="true" />
      <NODE name="reference" description="Options to define a reference file (use either &apos;file&apos; or &apos;index&apos;, not both)">
        <ITEM name="file" value="" type="input-file" description="File to use as reference (same file format as input files required)" required="false" advanced="false" supported_formats="*.featureXML,*.mzML" />
        <ITEM name="index" value="0" type="int" description="Use one of the input files as reference (&apos;1&apos; for the first file, etc.).#br#If &apos;0&apos;, no explicit reference is set - the algorithm will select a reference." required="false" advanced="false" restrictions="0:" />
      </NODE>
      <NODE name="algorithm" description="Algorithm parameters section">
        <ITEM name="max_num_peaks_considered" value="1000" type="int" description="The maximal number of peaks/features to be considered per map. To use all, set to &apos;-1&apos;." required="false" advanced="false" restrictions="-1:" />
        <NODE name="superimposer" description="">
          <ITEM name="mz_pair_max_distance" value="0.5" type="double" description="Maximum of m/z deviation of corresponding elements in different maps.  This condition applies to the pairs considered in hashing." required="false" advanced="false" restrictions="0.0:" />
          <ITEM name="rt_pair_distance_fraction" value="0.1" type="double" description="Within each of the two maps, the pairs considered for pose clustering must be separated by at least this fraction of the total elution time interval (i.e., max - min).  " required="false" advanced="true" restrictions="0.0:1.0" />
          <ITEM name="num_used_points" value="2000" type="int" description="Maximum number of elements considered in each map (selected by intensity).  Use this to reduce the running time and to disregard weak signals during alignment.  For using all points, set this to -1." required="false" advanced="false" restrictions="-1:" />
          <ITEM name="scaling_bucket_size" value="5.0e-03" type="double" description="The scaling of the retention time interval is being hashed into buckets of this size during pose clustering.  A good choice for this would be a bit smaller than the error you would expect from repeated runs." required="false" advanced="false" restrictions="0.0:" />
          <ITEM name="shift_bucket_size" value="3.0" type="double" description="The shift at the lower (respectively, higher) end of the retention time interval is being hashed into buckets of this size during pose clustering.  A good choice for this would be about the time between consecutive MS scans." required="false" advanced="false" restrictions="0.0:" />
          <ITEM name="max_shift" value="1000.0" type="double" description="Maximal shift which is considered during histogramming (in seconds).  This applies for both directions." required="false" advanced="true" restrictions="0.0:" />
          <ITEM name="max_scaling" value="2.0" type="double" description="Maximal scaling which is considered during histogramming.  The minimal scaling is the reciprocal of this." required="false" advanced="true" restrictions="1.0:" />
          <ITEM name="dump_buckets" value="" type="string" description="[DEBUG] If non-empty, base filename where hash table buckets will be dumped to.  A serial number for each invocation will be appended automatically." required="false" advanced="true" />
          <ITEM name="dump_pairs" value="" type="string" description="[DEBUG] If non-empty, base filename where the individual hashed pairs will be dumped to (large!).  A serial number for each invocation will be appended automatically." required="false" advanced="true" />
        </NODE>
        <NODE name="pairfinder" description="">
          <ITEM name="second_nearest_gap" value="2.0" type="double" description="Only link features whose distance to the second nearest neighbors (for both sides) is larger by &apos;second_nearest_gap&apos; than the distance between the matched pair itself." required="false" advanced="false" restrictions="1.0:" />
          <ITEM name="use_identifications" value="false" type="bool" description="Never link features that are annotated with different peptides (features without ID&apos;s always match; only the best hit per peptide identification is considered)." required="false" advanced="false" />
          <ITEM name="ignore_charge" value="false" type="bool" description="false [default]: pairing requires equal charge state (or at least one unknown charge &apos;0&apos;); true: Pairing irrespective of charge state" required="false" advanced="false" />
          <ITEM name="ignore_adduct" value="true" type="string" description="true [default]: pairing requires equal adducts (or at least one without adduct annotation); true: Pairing irrespective of adducts" required="false" advanced="false" restrictions="true,false" />
          <NODE name="distance_RT" description="Distance component based on RT differences">
            <ITEM name="max_difference" value="100.0" type="double" description="Never pair features with a larger RT distance (in seconds)." required="false" advanced="false" restrictions="0.0:" />
            <ITEM name="exponent" value="1.0" type="double" description="Normalized RT differences ([0-1], relative to &apos;max_difference&apos;) are raised to this power (using 1 or 2 will be fast, everything else is REALLY slow)" required="false" advanced="true" restrictions="0.0:" />
            <ITEM name="weight" value="1.0" type="double" description="Final RT distances are weighted by this factor" required="false" advanced="true" restrictions="0.0:" />
          </NODE>
          <NODE name="distance_MZ" description="Distance component based on m/z differences">
            <ITEM name="max_difference" value="0.3" type="double" description="Never pair features with larger m/z distance (unit defined by &apos;unit&apos;)" required="false" advanced="false" restrictions="0.0:" />
            <ITEM name="unit" value="Da" type="string" description="Unit of the &apos;max_difference&apos; parameter" required="false" advanced="false" restrictions="Da,ppm" />
            <ITEM name="exponent" value="2.0" type="double" description="Normalized ([0-1], relative to &apos;max_difference&apos;) m/z differences are raised to this power (using 1 or 2 will be fast, everything else is REALLY slow)" required="false" advanced="true" restrictions="0.0:" />
            <ITEM name="weight" value="1.0" type="double" description="Final m/z distances are weighted by this factor" required="false" advanced="true" restrictions="0.0:" />
          </NODE>
          <NODE name="distance_intensity" description="Distance component based on differences in relative intensity (usually relative to highest peak in the whole data set)">
            <ITEM name="exponent" value="1.0" type="double" description="Differences in relative intensity ([0-1]) are raised to this power (using 1 or 2 will be fast, everything else is REALLY slow)" required="false" advanced="true" restrictions="0.0:" />
            <ITEM name="weight" value="0.0" type="double" description="Final intensity distances are weighted by this factor" required="false" advanced="true" restrictions="0.0:" />
            <ITEM name="log_transform" value="disabled" type="string" description="Log-transform intensities? If disabled, d = |int_f2 - int_f1| / int_max. If enabled, d = |log(int_f2 + 1) - log(int_f1 + 1)| / log(int_max + 1))" required="false" advanced="true" restrictions="enabled,disabled" />
          </NODE>
        </NODE>
      </NODE>
    </NODE>
  </NODE>
</PARAMETERS>
</tool>