OpenMS  2.7.0
IDRipper

IDRipper splits the protein/peptide identifications of an idXML file into several idXML files according their annotated file origin.

potential predecessor tools $ \longrightarrow $ IDRipper $ \longrightarrow $ potential successor tools
IDFilter IDMapper

Example

Assuming each peptide identification in a given idXML file is annotated with its file origin (e.g. IDRipper_test.idXML) :

<userParam type="string" name="file_origin" value="IDMerger1_test.idXML"/> or
<userParam type="string" name="file_origin" value="IDMerger2_test.idXML"/>

Obviously the file contains protein/peptide identifications of IDMerger1_test.idXML and IDMerger2_test.idXML.

Calling IDRipper with an input file (here: -in IDRipper_test.idXML) and an output directory (via out or out_path) will result in two idXML files stored in the specified directory and named according to their file origin.

In theory, merging files with IDMerger and splitting the resulting file with IDRipper will result in the original input files.

NOTE: The meta value "file_origin" is removed by the IDSplitter!

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:

IDRipper -- Split protein/peptide identification file into several files according to annotated file origin.
Full documentation: http://www.openms.de/doxygen/release/2.7.0/html/TOPP_IDRipper.html
Version: 2.7.0 Sep 13 2021, 20:58:47, Revision: 9110e58
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:
  IDRipper <options>

Options (mandatory options marked with '*'):
  -in <file>*        Input file, in which the protein/peptide identifications must be tagged with 'file_origi
                     n' (valid formats: 'idXML')
  -out <file>        The path to this file is used as the output directory. (valid formats: 'idXML')
  -out_path <file>   Directory for the output files after ripping according to 'file_origin'. If 'out_path' 
                     is set, 'out' is ignored.
                     
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
+IDRipperSplit protein/peptide identification file into several files according to annotated file origin.
version2.7.0 Version of the tool that generated this parameters file.
++1Instance '1' section for 'IDRipper'
in Input file, in which the protein/peptide identifications must be tagged with 'file_origin'input file*.idXML
out The path to this file is used as the output directory.output file*.idXML
out_path Directory for the output files after ripping according to 'file_origin'. If 'out_path' is set, 'out' is ignored.
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 Overrides tool-specific checkstrue,false
testfalse Enables the test mode (needed for internal use only)true,false