| Title: | Data normalization by matrix raking |
|---|---|
| Description: | Normalizes a data matrix `data` by raking (using the RAS method by Bacharach, see references) the Nrows by Ncols matrix such that the row means and column means equal 1. The result is a normalized data matrix `K=RAS`, a product of row mulipliers `R` and column multipliers `S` with the original matrix `A`. Missing information needs to be presented as `NA` values and not as zero values, because CONSTANd is able to ignore missing values when calculating the mean. Using CONSTANd normalization allows for the direct comparison of values between samples within the same and even across different CONSTANd-normalized data matrices. |
| Authors: | Joris Van Houtven [aut, trl], Geert Jan Bex [trl], Dirk Valkenborg [aut, cre] |
| Maintainer: | Dirk Valkenborg <[email protected]> |
| License: | file LICENSE |
| Version: | 1.15.0 |
| Built: | 2024-11-29 05:09:27 UTC |
| Source: | https://github.com/bioc/CONSTANd |
Normalizes the data matrix by raking the Nrows by Ncols matrix such that the row means and column means equal Ncols and Nrows, respectively.
CONSTANd(data, precision=1e-5, maxIterations=50, target=1)CONSTANd(data, precision=1e-5, maxIterations=50, target=1)
data |
Nrows by Ncols matrix. |
precision |
Combined allowed deviation (residual error) of col and row means from target value. |
maxIterations |
Maximum amount of iterations (1x row and 1x col per iteration). |
target |
The mean value of quantifications in each row and column after normalization. |
Normalizes the data matrix <data> by raking (using the RAS method by Bacharach, see references) the Nrows by Ncols matrix such that the row means and column means equal 1. The result is a normalized data matrix K=RAS, a product of row mulipliers R and column multipliers S with the original matrix A. Missing information needs to be presented as nan values and not as zero values, because CONSTANd is able to ignore nan-values when calculating the mean. The variable <maxIterations> is an integer value that denotes the number of raking cycles. The variable <precision> defines the stopping criteria based on the L1-norm as defined by Friedrich Pukelsheim, Bruno Simeone in "On the Iterative Proportional Fitting Procedure: Structure of Accumulation Points and L1-Error Analysis".
normalized_data |
Normalized data matrix 'K=RAS' in the RAS-formulation of the problem. |
convergence_trail |
Precision acquired after each raking iteration (last value is the final precision). |
R |
Row multipliers in the 'K=RAS' formulation of the problem. |
S |
Column multipliers in the 'K=RAS' formulation of the problem. |
Joris Van Houtven ([email protected]), Geert Jan Bex <[email protected]>, Dirk Valkenborg <[email protected]>
Maes, Evelyne, et al. "CONSTANd: A normalization method for isobaric labeled spectra by constrained optimization." Molecular & Cellular Proteomics 15.8 (2016): 2779-2790. https://doi.org/10.1074/mcp.M115.056911. Accessed 18 Oct. 2020.
Bacharach, Michael. "Estimating Nonnegative Matrices from Marginal Data." International Economic Review, vol. 6, no. 3, 1965, pp. 294–310. JSTOR, https://doi.org/10.2307%2F2525582. Accessed 18 Oct. 2020.
# generic use (mock data) data_matrix <- matrix(runif(20), c(5,4)) normalized_matrix <- CONSTANd(data_matrix)$normalized_data # customize parameters result <- CONSTANd(data_matrix, precision=1e-3, maxIterations=30) # explore parts of the result object normalized_matrix <- result$normalized_data num_iterations_performed <- length(result$convergence_trail) attained_precision <- result$convergence_trail[num_iterations_performed]# generic use (mock data) data_matrix <- matrix(runif(20), c(5,4)) normalized_matrix <- CONSTANd(data_matrix)$normalized_data # customize parameters result <- CONSTANd(data_matrix, precision=1e-3, maxIterations=30) # explore parts of the result object normalized_matrix <- result$normalized_data num_iterations_performed <- length(result$convergence_trail) attained_precision <- result$convergence_trail[num_iterations_performed]