grabMzmlBPC: Grab the BPC or TIC from a file

View source: R/grabMzmlFunctions.R

grabMzmlBPCR Documentation

Grab the BPC or TIC from a file

Description

The base peak intensity and total ion current are actually written into the mzML files and aren't encoded, making retrieval of BPC and TIC information blazingly fast if parsed correctly.

Usage

grabMzmlBPC(xml_data, rtrange, TIC = FALSE, incl_polarity)

Arguments

xml_data

An 'xml2' nodeset, usually created by applying 'read_xml' to an mzML file.

rtrange

A vector of length 2 containing an upper and lower bound on retention times of interest. Providing a range here can speed up load times (although not enormously, as the entire file must still be read) and reduce the final object's size.

TIC

Boolean. If TRUE, the TIC is extracted rather than the BPC.

incl_polarity

Boolean determining whether the polarity of the scan should be returned as a column in the table (positive mode = 1, negative mode = -1)

Value

A 'data.table' with columns for retention time (rt), and intensity (int).


RaMS documentation built on Oct. 9, 2024, 9:06 a.m.