view ctd/FeatureFinderIdentification.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="FeatureFinderIdentification" docurl="http://www.openms.de/documentation/TOPP_FeatureFinderIdentification.html" category="Quantitation" >
<description><![CDATA[Detects features in MS1 data based on peptide identifications.]]></description>
<manual><![CDATA[Detects features in MS1 data based on peptide identifications.]]></manual>
<citations>
  <citation doi="10.1038/nmeth.3959" url="" />
  <citation doi="10.1021/acs.jproteome.7b00248" 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="FeatureFinderIdentification" description="Detects features in MS1 data based on peptide identifications.">
    <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;FeatureFinderIdentification&apos;">
      <ITEM name="in" value="" type="input-file" description="Input file: LC-MS raw data" required="true" advanced="false" supported_formats="*.mzML" />
      <ITEM name="id" value="" type="input-file" description="Input file: Peptide identifications derived directly from &apos;in&apos;" required="true" advanced="false" supported_formats="*.idXML" />
      <ITEM name="id_ext" value="" type="input-file" description="Input file: &apos;External&apos; peptide identifications (e.g. from aligned runs)" required="false" advanced="false" supported_formats="*.idXML" />
      <ITEM name="out" value="" type="output-file" description="Output file: Features" required="true" advanced="false" supported_formats="*.featureXML" />
      <ITEM name="lib_out" value="" type="output-file" description="Output file: Assay library" required="false" advanced="false" supported_formats="*.traML" />
      <ITEM name="chrom_out" value="" type="output-file" description="Output file: Chromatograms" required="false" advanced="false" supported_formats="*.mzML" />
      <ITEM name="candidates_out" value="" type="output-file" description="Output file: Feature candidates (before filtering and model fitting)" required="false" advanced="false" supported_formats="*.featureXML" />
      <ITEM name="candidates_in" value="" type="input-file" description="Input file: Feature candidates from a previous run. If set, only feature classification and elution model fitting are carried out, if enabled. Many parameters are ignored." required="false" advanced="true" supported_formats="*.featureXML" />
      <ITEM name="debug" value="0" type="int" description="Sets the debug level" required="false" advanced="true" restrictions="0:" />
      <ITEM name="log" value="" type="string" description="Name of log file (created only when specified)" 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="extract" description="Parameters for ion chromatogram extraction">
        <ITEM name="batch_size" value="1000" type="int" description="Nr of peptides used in each batch of chromatogram extraction. Smaller values decrease memory usage but increase runtime." required="false" advanced="false" restrictions="1:" />
        <ITEM name="mz_window" value="10.0" type="double" description="m/z window size for chromatogram extraction (unit: ppm if 1 or greater, else Da/Th)" required="false" advanced="false" restrictions="0.0:" />
        <ITEM name="n_isotopes" value="2" type="int" description="Number of isotopes to include in each peptide assay." required="false" advanced="false" restrictions="2:" />
        <ITEM name="isotope_pmin" value="0.0" type="double" description="Minimum probability for an isotope to be included in the assay for a peptide. If set, this parameter takes precedence over &apos;extract:n_isotopes&apos;." required="false" advanced="true" restrictions="0.0:1.0" />
        <ITEM name="rt_quantile" value="0.95" type="double" description="Quantile of the RT deviations between aligned internal and external IDs to use for scaling the RT extraction window" required="false" advanced="true" restrictions="0.0:1.0" />
        <ITEM name="rt_window" value="0.0" type="double" description="RT window size (in sec.) for chromatogram extraction. If set, this parameter takes precedence over &apos;extract:rt_quantile&apos;." required="false" advanced="true" restrictions="0.0:" />
      </NODE>
      <NODE name="detect" description="Parameters for detecting features in extracted ion chromatograms">
        <ITEM name="peak_width" value="60.0" type="double" description="Expected elution peak width in seconds, for smoothing (Gauss filter). Also determines the RT extration window, unless set explicitly via &apos;extract:rt_window&apos;." required="false" advanced="false" restrictions="0.0:" />
        <ITEM name="min_peak_width" value="0.2" type="double" description="Minimum elution peak width. Absolute value in seconds if 1 or greater, else relative to &apos;peak_width&apos;." required="false" advanced="true" restrictions="0.0:" />
        <ITEM name="signal_to_noise" value="0.8" type="double" description="Signal-to-noise threshold for OpenSWATH feature detection" required="false" advanced="true" restrictions="0.1:" />
        <ITEM name="mapping_tolerance" value="0.0" type="double" description="RT tolerance (plus/minus) for mapping peptide IDs to features. Absolute value in seconds if 1 or greater, else relative to the RT span of the feature." required="false" advanced="false" restrictions="0.0:" />
      </NODE>
      <NODE name="svm" description="Parameters for scoring features using a support vector machine (SVM)">
        <ITEM name="samples" value="0" type="int" description="Number of observations to use for training (&apos;0&apos; for all)" required="false" advanced="false" restrictions="0:" />
        <ITEM name="no_selection" value="false" type="bool" description="By default, roughly the same number of positive and negative observations, with the same intensity distribution, are selected for training. This aims to reduce biases, but also reduces the amount of training data. Set this flag to skip this procedure and consider all available observations (subject to &apos;svm:samples&apos;)." required="false" advanced="false" />
        <ITEM name="xval_out" value="" type="output-file" description="Output file: SVM cross-validation (parameter optimization) results" required="false" advanced="false" supported_formats="*.csv" />
        <ITEM name="kernel" value="RBF" type="string" description="SVM kernel" required="false" advanced="false" restrictions="RBF,linear" />
        <ITEM name="xval" value="5" type="int" description="Number of partitions for cross-validation (parameter optimization)" required="false" advanced="false" restrictions="1:" />
        <ITEMLIST name="log2_C" type="double" description="Values to try for the SVM parameter &apos;C&apos; during parameter optimization. A value &apos;x&apos; is used as &apos;C = 2^x&apos;." required="false" advanced="false">
          <LISTITEM value="-5"/>
          <LISTITEM value="-3"/>
          <LISTITEM value="-1"/>
          <LISTITEM value="1"/>
          <LISTITEM value="3"/>
          <LISTITEM value="5"/>
          <LISTITEM value="7"/>
          <LISTITEM value="9"/>
          <LISTITEM value="11"/>
          <LISTITEM value="13"/>
          <LISTITEM value="15"/>
        </ITEMLIST>
        <ITEMLIST name="log2_gamma" type="double" description="Values to try for the SVM parameter &apos;gamma&apos; during parameter optimization (RBF kernel only). A value &apos;x&apos; is used as &apos;gamma = 2^x&apos;." required="false" advanced="false">
          <LISTITEM value="-15"/>
          <LISTITEM value="-13"/>
          <LISTITEM value="-11"/>
          <LISTITEM value="-9"/>
          <LISTITEM value="-7"/>
          <LISTITEM value="-5"/>
          <LISTITEM value="-3"/>
          <LISTITEM value="-1"/>
          <LISTITEM value="1"/>
          <LISTITEM value="3"/>
        </ITEMLIST>
        <ITEM name="epsilon" value="1.0e-03" type="double" description="Stopping criterion" required="false" advanced="true" restrictions="0.0:" />
        <ITEM name="cache_size" value="100.0" type="double" description="Size of the kernel cache (in MB)" required="false" advanced="true" restrictions="1.0:" />
        <ITEM name="no_shrinking" value="false" type="bool" description="Disable the shrinking heuristics" required="false" advanced="true" />
        <ITEM name="predictors" value="peak_apices_sum,var_xcorr_coelution,var_xcorr_shape,var_library_sangle,var_intensity_score,sn_ratio,var_log_sn_score,var_elution_model_fit_score,xx_lda_prelim_score,var_isotope_correlation_score,var_isotope_overlap_score,var_massdev_score,main_var_xx_swath_prelim_score" type="string" description="Names of OpenSWATH scores to use as predictors for the SVM (comma-separated list)" required="false" advanced="true" />
        <ITEM name="min_prob" value="0.0" type="double" description="Minimum probability of correctness, as predicted by the SVM, required to retain a feature candidate" required="false" advanced="true" restrictions="0.0:1.0" />
      </NODE>
      <NODE name="model" description="Parameters for fitting elution models to features">
        <ITEM name="type" value="symmetric" type="string" description="Type of elution model to fit to features" required="false" advanced="false" restrictions="symmetric,asymmetric,none" />
        <ITEM name="add_zeros" value="0.2" type="double" description="Add zero-intensity points outside the feature range to constrain the model fit. This parameter sets the weight given to these points during model fitting; &apos;0&apos; to disable." required="false" advanced="true" restrictions="0.0:" />
        <ITEM name="unweighted_fit" value="false" type="bool" description="Suppress weighting of mass traces according to theoretical intensities when fitting elution models" required="false" advanced="true" />
        <ITEM name="no_imputation" value="false" type="bool" description="If fitting the elution model fails for a feature, set its intensity to zero instead of imputing a value from the initial intensity estimate" required="false" advanced="true" />
        <ITEM name="each_trace" value="false" type="bool" description="Fit elution model to each individual mass trace" required="false" advanced="true" />
        <NODE name="check" description="Parameters for checking the validity of elution models (and rejecting them if necessary)">
          <ITEM name="min_area" value="1.0" type="double" description="Lower bound for the area under the curve of a valid elution model" required="false" advanced="true" restrictions="0.0:" />
          <ITEM name="boundaries" value="0.5" type="double" description="Time points corresponding to this fraction of the elution model height have to be within the data region used for model fitting" required="false" advanced="true" restrictions="0.0:1.0" />
          <ITEM name="width" value="10.0" type="double" description="Upper limit for acceptable widths of elution models (Gaussian or EGH), expressed in terms of modified (median-based) z-scores. &apos;0&apos; to disable. Not applied to individual mass traces (parameter &apos;each_trace&apos;)." required="false" advanced="true" restrictions="0.0:" />
          <ITEM name="asymmetry" value="10.0" type="double" description="Upper limit for acceptable asymmetry of elution models (EGH only), expressed in terms of modified (median-based) z-scores. &apos;0&apos; to disable. Not applied to individual mass traces (parameter &apos;each_trace&apos;)." required="false" advanced="true" restrictions="0.0:" />
        </NODE>
      </NODE>
    </NODE>
  </NODE>
</PARAMETERS>
</tool>