| OpenMS 2.5.0

FeatureLinkerUnlabeled

Groups corresponding features from multiple maps.

potential predecessor tools | FeatureLinkerUnlabeled | potential successor tools
FeatureFinderCentroided (or another feature detection algorithm) | ProteinQuantifier
MapAlignerPoseClustering (or another map alignment algorithm) | TextExporter
SeedListGenerator

This tool provides an algorithm for grouping corresponding features in multiple runs of label-free experiments. For more details and algorithm-specific parameters (set in the INI file) see "Detailed Description" in the algorithm documentation or the INI file table below.

FeatureLinkerUnlabeled takes several feature maps (featureXML files) and stores the corresponding features in a consensus map (consensusXML file). Feature maps can be created from MS experiments (peak data) using one of the FeatureFinder TOPP tools.

Advanced users can convert the consensusXML generated by this tool to EDTA using FileConverter and plot the distribution of distances in RT (or m/z) between different input files (can be done in Excel). The distribution should be Gaussian-like with very few points beyond the tails. Points far away from the Gaussian indicate a too wide tolerance. A Gaussian with its left/right tail trimmed indicates a too narrow tolerance.

See also
  FeatureLinkerUnlabeledQT FeatureLinkerLabeled

The command line parameters of this tool are:

    FeatureLinkerUnlabeled -- Groups corresponding features from multiple maps.

    Full documentation: http://www.openms.de/documentation/TOPP_FeatureLinkerUnlabeled.html

    Version: 2.5.0-GIT-NOTFOUND-GIT-NOTFOUND Sep 10 2020, 12:20:39, Revision: GIT-NOTFOUND

    To cite OpenMS:

      Rost HL, Sachsenberg T, Aiche S, Bielow C et al.. OpenMS: a flexible open-source software platform for mass spectrometry data analysis. Nat Meth. 2016; 13, 9: 741-748. doi:10.1038/nmeth.3959.

    Usage:

      FeatureLinkerUnlabeled <options>

    This tool has algorithm parameters that are not shown here! Please check the ini file for a detailed descript

    ion or use the --helphelp option.

    Options (mandatory options marked with '*'):

      -in <files>*        Input files separated by blanks (valid formats: 'featureXML', 'consensusXML')

      -out <file>*        Output file (valid formats: 'consensusXML')

      -design <file>      Input file containing the experimental design (valid formats: 'tsv')

      -keep_subelements   For consensusXML input only: If set, the sub-features of the inputs are transferred to

                          the output.

    Common TOPP options:

      -ini <file>         Use the given TOPP INI file

      -threads <n>        Sets the number of threads allowed to be used by the TOPP tool (default: '1')

      -write_ini <file>   Writes the default configuration file

      --help              Shows options

      --helphelp          Shows all options (including advanced)

    The following configuration subsections are valid:

     - algorithm   Algorithm parameters section

    You can write an example INI file using the '-write_ini' option.

    Documentation of subsection parameters can be found in the doxygen documentation or the INIFileEditor.

    For more information, please consult the online documentation for this tool:

      - http://www.openms.de/documentation/TOPP_FeatureLinkerUnlabeled.html

INI file documentation of this tool:

Legend:
required parameter
advanced parameter
+FeatureLinkerUnlabeled Groups corresponding features from multiple maps.
version 2.5.0-GIT-NOTFOUND-GIT-NOTFOUND Version of the tool that generated this parameters file.
++1 Instance '1' section for 'FeatureLinkerUnlabeled'
in[] input files separated by blanks input file*.featureXML,*.consensusXML
out Output file output file*.consensusXML
design input file containing the experimental design input file*.tsv
keep_subelements false For consensusXML input only: If set, the sub-features of the inputs are transferred to the output.true,false
log Name of log file (created only when specified)
debug 0 Sets the debug level
threads 1 Sets the number of threads allowed to be used by the TOPP tool
no_progress false Disables progress logging to command line true,false
force false Overwrite tool specific checks.true,false
test false Enables the test mode (needed for internal use only)true,false
+++algorithm Algorithm parameters section
second_nearest_gap 2.0 Only link features whose distance to the second nearest neighbors (for both sides) is larger by 'second_nearest_gap' than the distance between the matched pair itself.1.0:∞
use_identifications false Never link features that are annotated with different peptides (features without ID's always match; only the best hit per peptide identification is considered).true,false
ignore_charge false false [default]: pairing requires equal charge state (or at least one unknown charge '0'); true: Pairing irrespective of charge state true,false
ignore_adduct true true [default]: pairing requires equal adducts (or at least one without adduct annotation); true: Pairing irrespective of adducts true,false
++++distance_RT Distance component based on RT differences
max_difference 100.0 Never pair features with a larger RT distance (in seconds).0.0:∞
exponent 1.0 Normalized RT differences ([0-1], relative to 'max_difference') are raised to this power (using 1 or 2 will be fast, everything else is REALLY slow)0.0:∞
weight 1.0 Final RT distances are weighted by this factor 0.0:∞
++++distance_MZ Distance component based on m/z differences
max_difference 0.3 Never pair features with larger m/z distance (unit defined by 'unit')0.0:∞
unit Da Unit of the 'max_difference' parameter Da,ppm
exponent 2.0 Normalized ([0-1], relative to 'max_difference') m/z differences are raised to this power (using 1 or 2 will be fast, everything else is REALLY slow)0.0:∞
weight 1.0 Final m/z distances are weighted by this factor 0.0:∞
++++distance_intensity Distance component based on differences in relative intensity (usually relative to highest peak in the whole data set)
exponent 1.0 Differences in relative intensity ([0-1]) are raised to this power (using 1 or 2 will be fast, everything else is REALLY slow)0.0:∞
weight 0.0 Final intensity distances are weighted by this factor 0.0:∞
log_transform disabled 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))enabled,disabled