pqNorm: Probabilistic Quotient Normalisation

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/pqNorm.R

Description

PQN is currently the gold standard method used to normalise NMR spectra.

Usage

1
2
3
4
5
6
7
8
pqNorm(
  X,
  noi,
  use_ta = F,
  uv_used = "mode",
  calc_region = c(0.5, 9.5),
  bin_width = 0.01
)

Arguments

X

The numerical matrix containing the NMR data you wish to normalise. This should be a preprocessed matrix with baseline correction, tsp calibration and non-quantitative region removal performed on it. The rows must contain information of one whole spectrum and the columns contain the specific chemical shift variables.

noi

Takes an array that is row matched to the X matrix you are normalising with the values equaling the maximum noise estimation for each spectra respectively.

use_ta

Requires a boolean TRUE or FALSE if total area normalisation should be performed on the spectra before PQN is.

uv_used

PQN utilises finding the median or the mode, which are both Univariate methods. Recognises either the string 'median' or 'mode' to instruct which method to use. Default = 'mode'

calc_region

The lower and upper bounds of the spectrum that will be used to calculate the dilution coeficient

bin_width

The width of the bin when the spectra are binned

Details

How It Works:

PQN works by normalising experimental spectra in the provided X matrix in relation to a reference spectrum.

  1. pqNorm() creates the reference automatically by calculating the median spectrum of X as outlined in the initial methods paper (see 'See also')

  2. pqNorm() derives a quotient for each ppm value within the limits of shift in a experimental spectrum by dividing it's intensities with that of the reference spectrum's.

  3. The most frequently occurring (your choice of median or mode) quotient is calculated and is said to be the dilution coefficient (dilf) of that spectrum.

  4. The sample is then scaled with this dilf and will be comparable with all other spectra normalised with the reference spectrum.

Background Information:

Advantages:

Limitations:

Value

The output of this function is a list containing:

  1. The normalised version of X in the first element and

  2. A numerical array of the corresponding dilution factors calculated by the function.

Author(s)

kylebario1@gmail.com

See Also

The methods paper first describing PQN can be found here: https://doi.org/10.1021/ac051632c

Other Reference-Based: hmNorm(), qNorm2(), xfNorm()

Examples

1
2
3
data(X, noi)
pqNorm(X, noi)
cat(dilf_pqn)

kylebario/unorm documentation built on Dec. 21, 2021, 8:45 a.m.