checkCorrelation: Check correlation matrix

View source: R/misc.R

checkCorrelationR Documentation

Check correlation matrix

Description

Sanity checks for the correlation matrix.

Usage

checkCorrelation(m, returnMessage = FALSE, na.allowed = TRUE)

Arguments

m

TBA

returnMessage

TBA

na.allowed

TBA

Details

Checks the following properties:

  • Values must be between -1 and 1.

  • Diagonal must be equal to 1.

  • Matrix must be symmetric.

Value

Logical

Examples

NULL

gMCPLite documentation built on May 29, 2024, 7:38 a.m.