| OpenMS 2.5.0

QCExtractor

Extracts a table attachment of a given quality parameter from a qcML file as tabular (text) format.

pot. predecessor tools | QCExtractor | pot. successor tools
QCEmbedder
QCShrinker

If there is a table attached to a given qp that is needed as a single file, e.g. for easy input to plotting software, this can be extracted to a tabular (text) format.

- `qp` defines the qp name to which the table is attached;
- `run` the file that defined the run under which the qp for the attachment is aggregated as mzML file. The file is only used to extract the run name from the file name.
- `name` if no file for the run was given (or if the target qp is contained in a set), at least a name of the target run/set containing the the qp for the attachment has to be given.
- `set/run` if the target qp is contained in a set, this has to be set here;

Output is in csv format (see parameter `out_csv`) which can be easily parsed by many programs.

The command line parameters of this tool are:

    QCExtractor -- Extracts a table attachment to a given qc parameter.

    Full documentation: http://www.openms.de/documentation/UTILS_QCExtractor.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.

    To cite QCExtractor:

      Walzer M, Pernas LE, Nasso S, Bittremieux W, Nahnsen S, Kelchtermans P,  Martens, L. qcML: An Exchange Format for Quality Control Metrics from Mass Spectrometry Experiments. Molecular & Cellular Proteomics 2014; 13(8). doi:10.1074/mcp.M113.035907.

    Usage:

      QCExtractor <options>

    Options (mandatory options marked with '*'):

      -in <file>*        Input qcml file (valid formats: 'qcML')

      -qp <string>*      Target attachment qp.

      -run <file>        The file that defined the run under which the qp for the attachment is aggregated as

                         mzML file. The file is only used to extract the run name from the file name. (valid form

                         ats: 'mzML')

      -name <string>     If no file for the run was given (or if the target qp is contained in a set), at least

                         a name of the target run/set containing the the qp for the attachment has to be given.

      -out_csv <file>*   Output csv formatted table. (valid formats: 'csv')

    Common UTIL 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
+QCExtractor Extracts a table attachment to a given qc parameter.
version 2.5.0-GIT-NOTFOUND-GIT-NOTFOUND Version of the tool that generated this parameters file.
++1 Instance '1' section for 'QCExtractor'
in Input qcml file input file*.qcML
qp Target attachment qp.
run The file that defined the run under which the qp for the attachment is aggregated as mzML file. The file is only used to extract the run name from the file name.input file*.mzML
name If no file for the run was given (or if the target qp is contained in a set), at least a name of the target run/set containing the the qp for the attachment has to be given.
out_csv Output csv formatted table.output file*.csv
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