Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
IDMerger

Merges several idXML files into one idXML file.

potential predecessor tools $ \longrightarrow $ IDMerger $ \longrightarrow $ potential successor tools
MascotAdapter (or other ID engines) ConsensusID
IDFileConverter IDMapper

The peptide hits and protein hits of the input files will be written into the single output file. In general, the number of idXML files that can be merged into one file is not limited.

The combination of search engine and processing date/time should be unique for every identification run over all input files. If this is not the case, the date/time of a conflicting run will be increased in steps of seconds until the combination is unique.

If an additional file is given through the add_to parameter, identifications from the main inputs (in) are added to that file, but only for those peptide sequences that were not already present. Only the best peptide hit per identification (MS2 spectrum) is taken into account; peptide identifications and their corresponding protein identifications are transferred.

Alternatively, with the pepxml_protxml option, results from corresponding PeptideProphet and ProteinProphet runs can be combined. In this case, exactly two idXML files are expected as input: one containing data from a pepXML file, and the other containing data from a protXML file that was created based on the pepXML (meaningful results can only be obtained for matching files!). pepXML or protXML can be converted to idXML with the IDFileConverter tool.

Note
Currently mzIdentML (mzid) is not directly supported as an input/output format of this tool. Convert mzid files to/from idXML using IDFileConverter if necessary.

The command line parameters of this tool are:

IDMerger -- Merges several protein/peptide identification files into one file.
Version: 2.3.0 Jan  9 2018, 17:46:23, Revision: 38ae115

Usage:
  IDMerger <options>

Options (mandatory options marked with '*'):
  -in <files>*            Input files separated by blanks (valid formats: 'idXML')
  -out <file>*            Output file (valid formats: 'idXML')
  -add_to <file>          Optional input file. IDs from 'in' are added to this file, but only if the (modifie
                          d) peptide sequences are not present yet (considering only best hits per spectrum).
                          (valid formats: 'idXML')
  -annotate_file_origin   Store the original filename in each protein/peptide identification (meta value: 
                          file_origin).
  -pepxml_protxml         Merge idXML files derived from a pepXML and corresponding protXML file.
                          Exactly two input files are expected in this case. Not compatible with 'add_to'.
                          
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)

INI file documentation of this tool:

Legend:
required parameter
advanced parameter
+IDMergerMerges several protein/peptide identification files into one file.
version2.3.0 Version of the tool that generated this parameters file.
++1Instance '1' section for 'IDMerger'
in[] Input files separated by blanksinput file*.idXML
out Output fileoutput file*.idXML
add_to Optional input file. IDs from 'in' are added to this file, but only if the (modified) peptide sequences are not present yet (considering only best hits per spectrum).input file*.idXML
annotate_file_originfalse Store the original filename in each protein/peptide identification (meta value: file_origin).true,false
pepxml_protxmlfalse Merge idXML files derived from a pepXML and corresponding protXML file.
Exactly two input files are expected in this case. Not compatible with 'add_to'.
true,false
log Name of log file (created only when specified)
debug0 Sets the debug level
threads1 Sets the number of threads allowed to be used by the TOPP tool
no_progressfalse Disables progress logging to command linetrue,false
forcefalse Overwrite tool specific checks.true,false
testfalse Enables the test mode (needed for internal use only)true,false

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:22:06 using doxygen 1.8.13