describePredMat: Briefly describe a predictor matrix

In ppanko/immapTools: Convenience tools for IMMAP-related analyses

Description

Briefly describe a predictor matrix

Usage

describePredMat(predMat, usePcNames = FALSE)

Arguments

predMat	a numeric matrix.
usePcNames	a scalar boolean value indicating whether or not to include a report about principal components.

Details

The function splits the predictor matrix by categories: overall, incomplete variables, complete variables and principal components. The number or predictors and the names of the predictors are then withdrawn for each variable in each category and are returned to the user.

Value

a list containing information about the names and numbers of predictors.

Examples

data(iris)                                                      
irisPredMat <- matrix(0, ncol = ncol(iris), nrow = ncol(iris))  
dimnames(irisPredMat) <- list(names(iris), names(iris))         
irisPredMat[1, 2] <- 1                                          
irisPredMat[3, 1] <- 1                                          
diag(irisPredMat) <- 1                                          
                                                                
## Describe example predictor matrix                            
describePredMat(                                                
  predMat = irisPredMat                                   
)                                                               

ppanko/immapTools documentation built on Nov. 21, 2019, 12:28 a.m.