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

IDRipper splits the protein/peptide identification 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 their file origin.

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

NOTE: The meta value file origin is removed by the IDSplitter!!

The command line parameters of this tool are:

IDRipper -- Split protein/peptide identification file into several files according annotated file origin.
Version: 1.11.1 Nov 14 2013, 11:18:15, Revision: 11976

Usage:
  IDRipper <options>

Options (mandatory options marked with '*'):
  -in <file>*        IdXML-file, whereas the protein/peptide identifications must be tagged with file_origin 
                     (valid formats: 'idXML')
  -out <file>        The path to the file is used as the output directory. (valid formats: 'idXML')
  -out_path <file>   Directory for the idXML-files after ripping according file_origin tag. 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 annotated file origin.
version1.11.1 Version of the tool that generated this parameters file.
++1Instance '1' section for 'IDRipper'
in idXML-file, whereas the protein/peptide identifications must be tagged with file_origininput file*.idXML
out The path to the file is used as the output directory.output file*.idXML
out_path Directory for the idXML-files after ripping according file_origin tag. 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
testfalse Enables the test mode (needed for internal use only)true,false

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:24 using doxygen 1.8.5