iSFun (version 1.1.0)

preview.pls: Statistical description before using function ispls

Description

The function describes the basic statistical information of the data, including sample mean, sample variance of X and Y, the first direction of partial least squares method, etc.

Usage

preview.pls(x, y, L, scale.x = TRUE, scale.y = TRUE)

Arguments

x

list of data matrices, L datasets of explanatory variables.

y

list of data matrices, L datasets of dependent variables.

L

numeric, number of datasets.

scale.x

character, "TRUE" or "FALSE", whether or not to scale the variables x. The default is TRUE.

scale.y

character, "TRUE" or "FALSE", whether or not to scale the variables y. The default is TRUE.

Value

A 'preview.pls' object that contains the list of the following items.

• x: list of data matrices, L datasets of explanatory variables with centered columns. If scale.x is TRUE, the columns of L datasets are standardized to have mean 0 and standard deviation 1.

• y: list of data matrices, L datasets of dependent variables with centered columns. If scale.y is TRUE, the columns of L datasets are standardized to have mean 0 and standard deviation 1.

• loading: the estimated first direction vector.

• meanx: list of numeric vectors, column mean of the original datasets x.

• normx: list of numeric vectors, column standard deviation of the original datasets x.

• meany: list of numeric vectors, column mean of the original datasets y.

• normy: list of numeric vectors, column standard deviation of the original datasets y.

See Also

See Also as ispls.

Examples

# NOT RUN {
library(iSFun)
data("simData.pls")
x <- simData.pls$x
y <- simData.pls$y
L <- length(x)

prev_pls <- preview.pls(x = x, y = y, L = L, scale.x = TRUE, scale.y = TRUE)
# }