R/cv.test.R

In featureCorMatrix: Measurement Level Independent Feature Correlation Matrix

#' Calculates Cramer's V Correlation Coefficient
#'
#' \code{cv.test} returns the Cramer's V correlation coefficient
#'
#' The function calculates Cramer's V based on the results
#' of an Chi-Square-Test of Independence between two
#' categorical variables
#' @param x a vector (categorical or numerical values)
#' @param y a vector (categorical or numerical values)
#'
#' @return Cramer's V
#' @export
#'
#' @examples
#'cv.test(x = iris$Species, iris$Sepal.Length)

# Function Cramer's V ------------------------------------------------------

## Cramer's V is not implemented in R base package

# Update necessary: Violation of assumptions of Chi²-Test!
cv.test = function(x,y) {
  CV = base::sqrt(base::suppressWarnings(stats::chisq.test(x, y, correct = FALSE))$statistic /
    (base::length(x) * (base::min(base::length(base::unique(x)),base::length(base::unique(y))) - 1)))
  return(base::as.numeric(CV))
}