creNorm: Creatinine Normalisation

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

View source: R/creNorm.R

Description

Creatinine Normalisation (CN) is a useful method much like region of interest normalisation that can normalise spectra based on the total area of the creatinine signal at the chemical shift 3.05ppm.

Usage

1
creNorm(X, ppm = NULL, cre3 = c(3, 3.1), cre4 = c(4, 4.1), err = 5)

Arguments

X

A numerical matrix with rows being the spectra and columns being the chemical shift variables.

ppm

A numerical array holding the chemical shift values of the X matrix.

cre3

A concatenated numerical value of the lower and upper ppm values where the creatinine peak at 3.05 starts and ends.

cre4

A concatenated numerical value of the lower and upper ppm values where the creatinine peak at 4.05 starts and ends.

err

The level of error given when calculating the creatinine peak ratios. interperted as a percentage (i.e., 5 = 5%)

Details

How It Works:

  1. For each experimental spectra, the integral (total area) of the region defined by the bounds in the argument cre3 is calculated.

  2. Each intensity in that spectra is then divided by the integral. This is iterated over for all spectra.

Advantages:

Limitations:

Value

A list of:

  1. The normalised X matrix,

  2. A numerical array of the corresponding dilution factors, and

  3. The ratio of the creatinine signals (ideally should equal 0.667).

Author(s)

kylebario1@gmail.com

See Also

More on the methodology of CN and issue with using it are outlined here: https://doi.org/10.1021/ac051632c

Other Attribute-Based: qNorm(), roiNorm(), taNorm(), vecNorm()

Examples

1
2
3
4
5
6
7
8
9
# When X contains multiple spectra, ppm is not required
data(X)
creNorm(X)
cat(dilf_cre)

# When X has only one spectrum, ppm is required
data(X, ppm)
creNorm(X[1,], ppm)
cat(dilf_cre)

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