R/cramers_v.R

Defines functions cramersv

Documented in cramersv

#' Cramer's V
#'
#' This function calculates Cramer's V from an object created by the
#' \code{\link{chisq.test}} function from the \code{stats} package.
#' @param x An abject created by \code{\link{chisq.test}}.
#' @keywords frequency tables, measures of association, chi-square test
#' @export
#' @examples
#' cramersv(x)
#'
#' cramersv(chisq.test(testdata$extortion_victim, testdata$size))

cramersv = function(x)
{
    CV = sqrt(x$statistic /
                  (sum(x$observed) * (min(ncol(x$observed),
                                          nrow(x$observed)) - 1)))

    CV <- as.numeric(CV)
    names(CV) <- "Cramer's V"

    return(CV)
}
prestevez/estevez documentation built on Jan. 31, 2020, 12:31 a.m.