roiNorm: Region of Interest Normalisation

In kylebario/concentr8r: MRS Data Preprocessing and Normalisation

Region of Interest Normalisation

Description

This function normalises the spectra based on a specific area of the spectra. This is helpful when one region is constant across all spectra.

Usage

roiNorm(X, ppm = NULL, sh = c(2.5, 2.75))

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. Only necessary when X is an array, not when X is a matrix
sh	The numerical values defining the lower and upper regions of the Region of Interest. default = c(3,3.1).

Details

roiNorm() operates similar to creNorm() except the normalising factor is not specificly creatinine, it can be what ever region is of interest.

Value

This function assigns the normalised X argument (as X_roi) and the calculated dilution factors (as dilf_roi) to the global environment.

Author(s)

[e-mail]

See Also

A description of Region of Interest Normalisation can be found in this paper: http://dx.doi.org/10.1007/s11306-018-1400-6

Other Attribute-Based: creNorm(), q1Norm(), taNorm(), vecNorm()

Examples

data(X)
roiNorm(X, sh = c(1.5,2))
cat(dilf_roi)

kylebario/concentr8r documentation built on Nov. 9, 2022, 12:47 a.m.