Skip to contents

Sanity checks for the correlation matrix.

Usage

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

Arguments

m

TBA

returnMessage

TBA

na.allowed

TBA

Value

Logical

Details

Checks the following properties:

  • Values must be between -1 and 1.

  • Diagonal must be equal to 1.

  • Matrix must be symmetric.

Examples

NULL
#> NULL