guidedPLS {guidedPLS} | R Documentation |
Guided Partial Least Squares (guied-PLS)
Description
Four matrices X1, X2, Y1, and Y2 are required. X1 and Y1 are supposed to share the rows, X2 and Y2 are supposed to share the rows, and Y1 and Y2 are supposed to share the columns.
Usage
guidedPLS(X1, X2, Y1, Y2, k=.minDim(X1, X2, Y1, Y2),
cortest=FALSE, fullrank=TRUE, verbose=FALSE)
Arguments
X1 |
The input matrix which has N-rows and M-columns. |
Y1 |
The input matrix which has N-rows and L-columns. |
X2 |
The input matrix which has O-rows and P-columns. |
Y2 |
The input matrix which has O-rows and L-columns. |
k |
The number of low-dimension (k < N, M, L, O, Default: .minDim(X1, X2, Y1, Y2)) |
cortest |
If cortest is set as TRUE, t-test of correlation coefficient is performed (Default: FALSE) |
fullrank |
If fullrank is set as TRUE, irlba is used, otherwise fullrank SVD is used (Default: TRUE) |
verbose |
Verbose option (Default: FALSE) |
Value
res: object of svd() loadingYX1: Loading vector to project X1 to lower dimension via Y1 (M times k). loadingYX2: Loading vector to project X2 to lower dimension via Y2 (P times k). scoreX1: Projected X1 (N times k) scoreX2: Projected X2 (O times k) scoreYX1: Projected YX1 (L times k) scoreYX2: Projected YX2 (L times k) corYX1: Correlation Coefficient (Default: NULL) corYX2: Correlation Coefficient (Default: NULL) pvalYX1: P-value vector of corYX1 (Default: NULL) pvalYX2: P-value vector of corYX2 (Default: NULL) qvalYX1: Q-value vector of BH method against pvalYX1 (Default: NULL) qvalYX2: Q-value vector of BH method against pvalYX2 (Default: NULL)
Author(s)
Koki Tsuyuzaki
References
Le Cao, et al. (2008). A Sparse PLS for Variable Selection when Integrating Omics Data. Statistical Applications in Genetics and Molecular Biology, 7(1)
Reese S E, et al. (2013). A new statistic for identifying batch effects in high-throughput genomic data that uses guided principal component analysis. Bioinformatics, 29(22), 2877-2883
Examples
# Test data
data <- toyModel()
# Simple usage
out <- guidedPLS(X1=data$X1, X2=data$X2, Y1=data$Y1, Y2=data$Y2, k=4)