Nothing
#' Correlation Matrix
#'
#' This function computes a correlation matrix based on Pearson product-moment
#' correlation coefficient, Spearman's rank-order correlation coefficient,
#' Kendall's Tau-b correlation coefficient, or Kendall-Stuart's Tau-c correlation
#' coefficient and computes significance values (\emph{p}-values) for testing the
#' hypothesis H0: \eqn{\rho} = 0 for all pairs of variables.
#'
#' Note that unlike the \code{\link[stats:cor.test]{cor.test}} function, this
#' function does not compute an exact \emph{p}-value for Spearman's rank-order
#' correlation coefficient or Kendall's Tau-b correlation coefficient, but uses
#' the asymptotic \emph{t} approximation.
#'
#' Statistically significant correlation coefficients can be shown in boldface on
#' the console when specifying \code{sig = TRUE}. However, this option is not supported
#' when using R Markdown, i.e., the argument \code{sig} will switch to \code{FALSE}.
#'
#'
#' @param x a matrix or data frame.
#' @param method a character vector indicating which correlation coefficient
#' is to be computed, i.e. \code{"pearson"} for Pearson product-
#' moment correlation coefficient (default), \code{"spearman"}
#' for Spearman's rank-order correlation coefficient, \code{kendall-b}
#' for Kendall's Tau-b correlation coefficient or \code{kendall-c}
#' for Kendall-Stuart's Tau-c correlation coefficient.
#' @param na.omit logical: if \code{TRUE}, incomplete cases are removed before
#' conducting the analysis (i.e., listwise deletion); if \code{FALSE}
#' (default), pairwise deletion is used.
#' @param group a numeric vector, character vector of factor as grouping
#' variable to show results for each group separately, i.e.,
#' upper triangular for one group and lower triangular for
#' another group. Note that the grouping variable is limited
#' to two groups.
#' @param sig logical: if \code{TRUE}, statistically significant correlation
#' coefficients are shown in boldface on the console.
#' @param alpha a numeric value between 0 and 1 indicating the significance
#' level at which correlation coefficients are printed boldface
#' when \code{sig = TRUE}.
#' @param print a character string or character vector indicating which results
#' to show on the console, i.e. \code{"all"} for all results,
#' \code{"cor"} for correlation coefficients, \code{"n"} for the
#' sample sizes, \code{"stat"} for the test statistic, \code{"df"}
#' for the degrees of freedom, and \code{"p"} for \emph{p}-values.
#' @param tri a character string indicating which triangular of the matrix
#' to show on the console, i.e., \code{both} for upper and lower
#' triangular, \code{lower} (default) for the lower triangular,
#' and \code{upper} for the upper triangular.
#' @param p.adj a character string indicating an adjustment method for multiple
#' testing based on \code{\link{p.adjust}}, i.e., \code{none} ,
#' \code{bonferroni}, \code{holm} (default), \code{hochberg},
#' \code{hommel}, \code{BH}, \code{BY}, or \code{fdr}.
#' @param continuity logical: if \code{TRUE} (default), continuity correction is
#' used for testing Spearman's rank-order correlation coefficient
#' and Kendall's Tau-b correlation.
#' @param digits an integer value indicating the number of decimal places to be
#' used for displaying correlation coefficients.
#' @param p.digits an integer value indicating the number of decimal places to be
#' used for displaying \emph{p}-values.
#' @param as.na a numeric vector indicating user-defined missing values,
#' i.e. these values are converted to \code{NA} before conducting
#' the analysis.
#' @param check logical: if \code{TRUE}, argument specification is checked.
#' @param write a character string for writing the results into a Excel file
#' naming a file with or without file extension '.xlsx', e.g.,
#' \code{"Results.xlsx"} or \code{"Results"}.
#' @param output logical: if \code{TRUE}, output is shown on the console.
#'
#' @author
#' Takuya Yanagida \email{takuya.yanagida@@univie.ac.at}
#'
#' @seealso
#' \code{\link{cohens.d}}, \code{\link{cor.cont}},
#' \code{\link{cor.cramer}}, \code{\link{multilevel.icc}}, \code{\link{cor.phi}},
#' \code{\link{na.auxiliary}}, \code{\link{size.cor}}, \code{\link{write.result}}
#'
#' @references
#' Rasch, D., Kubinger, K. D., & Yanagida, T. (2011). \emph{Statistics in psychology
#' - Using R and SPSS}. John Wiley & Sons.
#'
#' @return
#' Returns an object of class \code{misty.object}, which is a list with following
#' entries:
#' \tabular{ll}{
#' \code{call} \tab function call \cr
#' \code{type} \tab type of analysis \cr
#' \code{data} \tab matrix or data frame specified in \code{x} \cr
#' \code{args} \tab specification of function arguments \cr
#' \code{result} \tab result table \cr
#' }
#'
#' @export
#'
#' @examples
#' dat <- data.frame(group = c("a", "a", "a", "a", "a",
#' "b", "b", "b", "b", "b"),
#' x = c(5, NA, 6, 4, 6, 7, 9, 5, 8, 7),
#' y = c(3, 3, 5, 6, 7, 4, 7, NA, NA, 8),
#' z = c(1, 3, 1, NA, 2, 4, 6, 5, 9, 6))
#'
#' # Pearson product-moment correlation coefficient
#' cor.matrix(dat[, c("x", "y")])
#'
#' # Pearson product-moment correlation coefficient matrix using pairwise deletion
#' cor.matrix(dat[, c("x", "y", "z")])
#'
#' # Spearman's rank-order correlation matrix using pairwise deletion
#' cor.matrix(dat[, c("x", "y", "z")], method = "spearman")
#'
#' # Kendall's Tau-b correlation matrix using pairwise deletion
#' cor.matrix(dat[, c("x", "y", "z")], method = "kendall-b")
#'
#' # Kendall-Stuart's Tau-c correlation matrix using pairwise deletion
#' cor.matrix(dat[, c("x", "y", "z")], method = "kendall-c")
#'
#' # Pearson product-moment correlation coefficient matrix using pairwise deletion
#' # highlight statistically significant result at alpha = 0.05
#' cor.matrix(dat[, c("x", "y", "z")], sig = TRUE)
#'
#' # Pearson product-moment correlation coefficient matrix using pairwise deletion
#' # highlight statistically significant result at alpha = 0.05
#' cor.matrix(dat[, c("x", "y", "z")], sig = TRUE, alpha = 0.10)
#'
#' # Pearson product-moment correlation coefficient matrix using pairwise deletion,
#' # print sample size and significance values
#' cor.matrix(dat[, c("x", "y", "z")], print = "all")
#'
#' # Pearson product-moment correlation coefficient matrix using listwise deletion,
#' # print sample size and significance values
#' cor.matrix(dat[, c("x", "y", "z")], na.omit = TRUE, print = "all")
#'
#' # Pearson product-moment correlation coefficient matrix using listwise deletion,
#' # print sample size and significance values with Bonferroni correction
#' cor.matrix(dat[, c("x", "y", "z")], na.omit = TRUE, print = "all", p.adj = "bonferroni")
#'
#' # Pearson product-moment correlation coefficient using pairwise deletion,
#' # results for group "a" and "b" separately
#' cor.matrix(dat[, c("x", "y")], group = dat$group)
#'
#' # Pearson product-moment correlation coefficient matrix using pairwise deletion,
#' # results for group "a" and "b" separately
#' cor.matrix(dat[, c("x", "y", "z")], group = dat$group, print = "all")
#'
#' \dontrun{
#' # Write Results into a Excel file
#' cor.matrix(dat[, c("x", "y", "z")], print = "all", write = "Correlation.xlsx")
#'
#' result <- cor.matrix(dat[, c("x", "y", "z")], print = "all", output = FALSE)
#' write.result(result, "Correlation.xlsx")
#' }
cor.matrix <- function(x, method = c("pearson", "spearman", "kendall-b", "kendall-c"),
na.omit = FALSE, group = NULL, sig = FALSE, alpha = 0.05,
print = c("all", "cor", "n", "stat", "df", "p"),
tri = c("both", "lower", "upper"),
p.adj = c("none", "bonferroni", "holm", "hochberg", "hommel", "BH", "BY", "fdr"),
continuity = TRUE, digits = 2, p.digits = 3, as.na = NULL,
write = NULL, check = TRUE, output = TRUE) {
#_____________________________________________________________________________
#
# Initial Check --------------------------------------------------------------
# Check if input 'x' is missing
if (isTRUE(missing(x))) { stop("Please specify a matrix or data frame for the argument 'x'.", call. = FALSE) }
# Check if input 'x' is NULL
if (isTRUE(is.null(x))) { stop("Input specified for the argument 'x' is NULL.", call. = FALSE) }
# Matrix or data frame for the argument 'x'?
if (isTRUE(!is.matrix(x) && !is.data.frame(x))) { stop("Please specifiy a matrix or data frame for the argument 'x'.", call. = FALSE) }
#-----------------------------------------
# As data frame
# Is 'x' a matrix?
is.mat <- is.matrix(x) && !is.data.frame(x)
# Coerce to a data frame
x <- as.data.frame(x, stringsAsFactors = FALSE)
#......
# Convert 'group' into a vector
group <- unlist(group, use.names = FALSE)
#_____________________________________________________________________________
#
# Input Check ----------------------------------------------------------------
# Check input 'check'
if (isTRUE(!is.logical(check))) { stop("Please specify TRUE or FALSE for the argument 'check'.", call. = FALSE) }
if (isTRUE(check)) {
# Check input 'x'
if (isTRUE(any(vapply(x, function(y) !is.numeric(y), FUN.VALUE = logical(1L))))) { stop("Please specify a matrix or data frame with numeric vectors.", call. = FALSE) }
# Check input 'method'
if (isTRUE(any(!method %in% c("pearson", "spearman", "kendall-b", "kendall-c")))) { stop("Character string in the argument 'method' does not match with \"pearson\", \"spearman\", \"kendall-b\", or \"kendall-c\".", call. = FALSE) }
# Check input 'na.omit'
if (isTRUE(!is.logical(na.omit))) { stop("Please specify TRUE or FALSE for the argument 'na.omit'.", call. = FALSE) }
# Check input 'group'
if (isTRUE(!is.null(group))) {
# Length of 'group' match with 'x'?
if (isTRUE(length(group) != nrow(x))) {
if (isTRUE(is.vector(group) && !is.factor(group))) {
# Matrix
if (isTRUE(is.mat)) {
stop("Length of the vector specified in 'group' does not match the number of rows of the matrix specified in 'x'.",
call. = FALSE)
# Data frame
} else {
stop("Length of the vector specified in 'group' does not match the number of rows of the data frame specified in 'x'.",
call. = FALSE)
}
# Factor
} else {
# Matrix
if (isTRUE(is.mat)) {
stop("Length of the factor specified in 'group' does not match the number of rows of the matrix specified in 'x'.",
call. = FALSE)
# Data frame
} else {
stop("Length of the factor specified in 'group' does not match the number of rows of the data frame specified in 'x'.",
call. = FALSE)
}
}
}
# Specified two groups only?
if (isTRUE(length(na.omit(unique(group))) != 2L)) {
stop("Please specify a grouping variable with only two groups for the argument 'group'.", call. = FALSE)
}
# Zero variance in one of the groups
x.zero.var <- vapply(split(x, f = group), function(y) apply(y, 2L, function(z) length(na.omit(unique(z))) == 1L), FUN.VALUE = logical(ncol(x)))
if (isTRUE(any(x.zero.var))) {
stop(paste("Following variables specified in 'x' have zero variance in at least one of the groups specified in 'group': ",
paste(names(which(apply(x.zero.var, 1, any))), collapse = ", ")), call. = FALSE)
}
}
# Check input 'sig'
if (isTRUE(!is.logical(sig))) { stop("Please specify TRUE or FALSE for the argument 'sig'.", call. = FALSE) }
# Check input 'alpha'
if (isTRUE(alpha >= 1L || alpha <= 0L)) { stop("Please specify a number between 0 and 1 for the argument 'alpha'.", call. = FALSE) }
# Check input 'print'
if (isTRUE(any(!print %in% c("all", "cor", "n", "stat", "df", "p")))) { stop("Character string(s) in the argument 'print' does not match with \"all\", \"cor\", \"n\", \"stat\", \"df\", or \"p\".", call. = FALSE) }
# Check input 'tri'
if (isTRUE(any(!tri %in% c("both", "lower", "upper")))) { stop("Character string in the argument 'tri' does not match with \"both\", \"lower\", or \"upper\".", call. = FALSE) }
# Check input 'p.adj'
if (isTRUE(any(!p.adj %in% c("none", "holm", "bonferroni", "hochberg", "hommel", "BH", "BY", "fdr")))) { stop("Character string in the argument 'p.adj' does not match with \"none\", \"bonferroni\", \"holm\", \"hochberg\", \"hommel\", \"BH\", \"BY\", or \"fdr\".", call. = FALSE) }
# Check input 'digits'
if (isTRUE(digits %% 1L != 0L || digits < 0L)) { stop("Please specify a positive integer number for the argument 'digits'.", call. = FALSE) }
# Check input 'p.digits'
if (isTRUE(p.digits %% 1L != 0L || p.digits < 0L)) { stop("Please specify a positive integer number for the argument 'p.digits'.", call. = FALSE) }
# Check input 'output'
if (isTRUE(!is.logical(output))) { stop("Please specify TRUE or FALSE for the argument 'output'.", call. = FALSE) }
# Check input 'x' for zero variance
x.zero.var <- vapply(x, function(y) length(na.omit(unique(y))) == 1L, FUN.VALUE = logical(1L))
if (isTRUE(any(x.zero.var))) {
warning(paste0("Following variables in the matrix or data frame specified in 'x' have zero variance: ",
paste(names(which(x.zero.var)), collapse = ", ")), call. = FALSE)
}
}
#_____________________________________________________________________________
#
# Data and Variables ---------------------------------------------------------
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
## Convert user-missing values into NA ####
if (isTRUE(!is.null(as.na))) {
x <- misty::as.na(x, na = as.na, check = check)
# Variable with missing values only
x.miss <- vapply(x, function(y) all(is.na(y)), FUN.VALUE = logical(1L))
if (isTRUE(any(x.miss))) {
stop(paste0("After converting user-missing values into NA, following variables are completely missing: ",
paste(names(which(x.miss)), collapse = ", ")), call. = FALSE)
}
# Constant variables
x.con <- vapply(x, function(y) var(as.numeric(y), na.rm = TRUE) == 0L, FUN.VALUE = logical(1))
if (isTRUE(any(x.con))) {
stop(paste0("After converting user-missing values into NA, following variables are constant: ",
paste(names(which(x.con)), collapse = ", ")), call. = FALSE)
}
}
# Missing data
attr(x, "missing") <- any(is.na(x))
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
## Correlation coefficient ####
method <- ifelse(all(c("pearson", "spearman", "kendall-b", "kendall-c") %in% method), "pearson", method)
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
## Internal function: Kendall-Stuart Tau-c ####
if (isTRUE(method == "kendall-c")) {
.internal.tau.c <- function(xx, yy) {
#_________________________________________________________________________
#
# Main Function ----------------------------------------------------------
# Contingency table
x.table <- table(xx, yy)
# Number of rows
x.nrow <- nrow(x.table)
# Number of columns
x.ncol <- ncol(x.table)
# Sample size
x.n <- sum(x.table)
# Minimum of number of rows/columns
x.m <- min(dim(x.table))
#-----------------------------------------
if (isTRUE(x.n > 1L && x.nrow > 1L && x.ncol > 1L)) {
pi.c <- pi.d <- matrix(0L, nrow = x.nrow, ncol = x.ncol)
x.col <- col(x.table)
x.row <- row(x.table)
for (i in 1L:x.nrow) {
for (j in 1L:x.ncol) {
pi.c[i, j] <- sum(x.table[x.row < i & x.col < j]) + sum(x.table[x.row > i & x.col > j])
pi.d[i, j] <- sum(x.table[x.row < i & x.col > j]) + sum(x.table[x.row > i & x.col < j])
}
}
# Concordant
x.con <- sum(pi.c * x.table)/2L
# Discordant
x.dis <- sum(pi.d * x.table)/2L
# Kendall-Stuart Tau-c
tau.c <- (x.m*2L * (x.con - x.dis)) / ((x.n^2L) * (x.m - 1L))
} else {
tau.c <- NA
}
#-----------------------------------------
# If n > 2
if (isTRUE(x.n > 2L & x.nrow > 1L & x.ncol > 1L)) {
# Asymptotic standard error
sigma <- sqrt(4L * x.m^2L / ((x.m - 1L)^2L * x.n^4L) * (sum(x.table * (pi.c - pi.d)^2L) - 4L * (x.con - x.dis)^2L / x.n))
# Test statistic
z <- tau.c / sigma
# Two-tailed p-value
pval <- pnorm(abs(z), lower.tail = FALSE)*2L
} else {
sigma <- NA
z <- NA
pval <- NA
}
#_________________________________________________________________________
#
# Return Object ----------------------------------------------------------
object <- list(result = list(tau.c = tau.c,
n = x.n,
sigma = sigma,
stat = z,
df = NA,
pval = pval))
return(object)
}
}
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
## Internal function: Significance testing Pearson correlation ####
.internal.cor.test.pearson <- function(x, y) {
# At least three cases
if (isTRUE(nrow(na.omit(data.frame(x = x, y = y))) >= 3L)) {
result.cor.test <- suppressWarnings(cor.test(x, y, method = "pearson"))
object <- list(stat = result.cor.test$statistic,
df = result.cor.test$parameter,
pval = result.cor.test$p.value)
# Less than three cases
} else {
object <- list(stat = NA, df = NA, pval = NA)
}
return(object)
}
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
## Internal function: Significance testing Spearman correlation ####
.internal.cor.test.spearman <- function(x, y, continuity) {
# Complete data
xy.dat <- na.omit(data.frame(x = x, y = y))
# Number of cases
n <- nrow(xy.dat)
# At least three cases
if (isTRUE(n >= 3L)) {
# Correlation coefficient
r <- cor(xy.dat[, c("x", "y")], method = "spearman")[1L, 2L]
# Continuity correction
if (isTRUE(continuity)) {
r <- 1L - ((n^3L - n) * (1L - r) / 6L) / (((n * (n^2L - 1)) / 6L) + 1)
}
# Test statistic
stat <- r * sqrt((n - 2L) / (1 - r^2L))
# Degrees of freedom
df <- n - 2L
# p-value
pval <- min(pt(stat, df = df),
pt(stat, df = df, lower.tail = FALSE))*2L
# Return object
object <- list(stat = stat, df = df, pval = pval)
# Less than three cases
} else {
# Return object
object <- list(stat = NA, df = NA, pval = NA)
}
return(object)
}
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
## Internal function: Significance testing Kendall Tau-b ####
.internal.cor.test.kendall.b <- function(x, y, continuity) {
# Complete data
xy.dat <- na.omit(data.frame(x = x, y = y))
# Number of cases
n <- nrow(xy.dat)
# At least three cases
if (isTRUE(n >= 3L)) {
# Correlation coefficient
r <- cor(xy.dat[, c("x","y")], method = "kendall")[1L, 2L]
xties <- table(x[duplicated(x)]) + 1L
yties <- table(y[duplicated(y)]) + 1L
T0 <- n * (n - 1L)/2L
T1 <- sum(xties * (xties - 1L))/2L
T2 <- sum(yties * (yties - 1L))/2L
S <- r * sqrt((T0 - T1) * (T0 - T2))
v0 <- n * (n - 1L) * (2L * n + 5L)
vt <- sum(xties * (xties - 1L) * (2L * xties + 5L))
vu <- sum(yties * (yties - 1L) * (2L * yties + 5L))
v1 <- sum(xties * (xties - 1L)) * sum(yties * (yties - 1L))
v2 <- sum(xties * (xties - 1L) * (xties - 2)) * sum(yties * (yties - 1L) * (yties - 2L))
var_S <- (v0 - vt - vu) / 18L + v1 / (2L * n * (n - 1L)) + v2 / (9L * n * (n - 1L) * (n - 2L))
# Continuity correction
if (isTRUE(continuity)) {
S <- sign(S) * (abs(S) - 1)
}
# Test statistic
stat <- S / sqrt(var_S)
# p-value
pval <- min(pnorm(stat),
pnorm(stat, lower.tail = FALSE))*2L
object <- list(stat = stat, df = NA, pval = pval)
# Less than three cases
} else {
object <- list(stat = NA, df = NA, pval = NA)
}
return(object)
}
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
## Listwise deletion ####
if (isTRUE(na.omit)) {
# Without grouping variable
if (isTRUE(is.null(group))) {
x <- na.omit(x)
# With grouping variable
} else {
x.group <- na.omit(data.frame(x, group))
x <- x.group[, colnames(x)]
group <- x.group[, "group"]
}
}
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
## Print correlation, sample size or significance values ####
if (isTRUE(all(c("all", "cor", "n", "stat", "df", "p") %in% print))) { print <- "cor" }
if (isTRUE(method %in% c("pearson", "spearman"))) {
if (isTRUE(length(print) == 1L && "all" %in% print)) { print <- c("cor", "n", "stat", "df", "p") }
} else {
if (isTRUE(length(print) == 1L && "all" %in% print)) { print <- c("cor", "n", "stat", "p") }
}
# Check input 'print'
if (isTRUE(print == "df" & method %in% c("kendall-b", "kendall-c"))) {
switch(method, "kendall-b" = {
stop("There are no degrees of freedom (df) for testing the Kendall's Tau-b correlation coefficient.",
call. = FALSE)
}, "kendall-c" = {
stop("There are no degrees of freedom (df) for testing the Kendall-Stuart's Tau-c correlation coefficient.",
call. = FALSE)
})
}
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
## Print triangular ####
if (isTRUE(is.null(group))) {
tri <- ifelse(all(c("both", "lower", "upper") %in% tri), "lower", tri)
} else {
tri <- "both"
}
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
## Adjustment method for multiple testing ####
p.adj <- ifelse(all(c("none", "bonferroni", "holm", "hochberg", "hommel", "BH", "BY", "fdr") %in% p.adj), "none", p.adj)
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
## Pairwise combination of columns ####
comb <- combn(seq_len(ncol(x)), m = 2L)
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
## Sample size, t statistic, df, and p-value matrix ####
p.mat <- df.mat <- stat.mat <- n.mat <- matrix(NA, ncol = ncol(x), nrow = ncol(x), dimnames = list(colnames(x), colnames(x)))
#_____________________________________________________________________________
#
# Main Function --------------------------------------------------------------
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
## No grouping ####
if (isTRUE(is.null(group))) {
#...................
### Correlation matrix ####
# Product-moment or Spearman correlation coefficient
if (isTRUE(!method %in% c("kendall-b", "kendall-c"))) {
cor.mat <- suppressWarnings(cor(x, use = "pairwise.complete.obs", method = method))
# Kendall Tau-b
} else if (isTRUE(method == "kendall-b")) {
cor.mat <- suppressWarnings(cor(x, use = "pairwise.complete.obs", method = "kendall"))
# Kendall-Stuart Tau-c
} else if (isTRUE(method == "kendall-c")) {
cor.test.res <- apply(comb, 2, function(y) suppressWarnings(.internal.tau.c(x[, y[1L]], x[, y[2L]])$result))
cor.mat <- matrix(NA, ncol = ncol(x), nrow = ncol(x), dimnames = list(colnames(x), colnames(x)))
cor.mat[lower.tri(cor.mat)] <- sapply(cor.test.res, function(y) y$tau.c)
cor.mat[upper.tri(cor.mat)] <- t(cor.mat)[upper.tri(cor.mat)]
diag(cor.mat) <- 1L
}
#...................
### Sample size ####
if (!isTRUE(na.omit)) {
n <- apply(comb, 2L, function(y) nrow(na.omit(cbind(x[, y[1L]], x[, y[2L]]))))
} else {
n <- nrow(na.omit(x))
}
n.mat[lower.tri(n.mat)] <- n
n.mat[upper.tri(n.mat)] <- t(n.mat)[upper.tri(n.mat)]
#...................
### Test statistic, df and p-values ####
# Product-moment or Spearman correlation coefficient
switch(method, "pearson" = {
cor.test.res <- apply(comb, 2, function(y) suppressWarnings(.internal.cor.test.pearson(x[, y[1L]], x[, y[2L]])))
# Spearman correlation coefficient
}, "spearman" = {
cor.test.res <- apply(comb, 2, function(y) suppressWarnings(.internal.cor.test.spearman(x[, y[1L]], x[, y[2L]], continuity = continuity)))
# Kendall Tau-b
}, "kendall-b" = {
cor.test.res <- apply(comb, 2, function(y) suppressWarnings(.internal.cor.test.kendall.b(x[, y[1L]], x[, y[2L]], continuity = continuity)))
})
# Test statistic
stat <- sapply(cor.test.res, function(y) y$stat)
# Degrees of freedom
df <- sapply(cor.test.res, function(y) y$df)
# p-values
pval <- sapply(cor.test.res, function(y) y$pval)
###
# Adjust p-values for multiple comparison
if (isTRUE(p.adj != "none")) {
pval <- p.adjust(pval, method = p.adj)
}
stat.mat[lower.tri(stat.mat)] <- stat
stat.mat[upper.tri(stat.mat)] <- t(stat.mat)[upper.tri(stat.mat)]
df.mat[lower.tri(df.mat)] <- df
df.mat[upper.tri(df.mat)] <- t(df.mat)[upper.tri(df.mat)]
p.mat[lower.tri(p.mat)] <- pval
p.mat[upper.tri(p.mat)] <- t(p.mat)[upper.tri(p.mat)]
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
## Grouping ####
} else {
# At least 3 observations
if (isTRUE(any(table(group) < 3L))) {
stop("There are not enough observations for each group specified in 'group' to compute the correlation matrix separately.", call. = FALSE)
}
# Grouping
x.group <- split(x, f = group)
object.g1 <- misty::cor.matrix(x.group[[1L]], method = method, na.omit = na.omit, group = NULL,
digits = digits, continuity = continuity, print = print, tri = tri,
p.adj = p.adj, p.digits = p.digits, check = FALSE, output = FALSE)
object.g2 <- misty::cor.matrix(x.group[[2L]], method = method, na.omit = na.omit, group = NULL,
digits = digits, continuity = continuity, print = print, tri = tri,
p.adj = p.adj, p.digits = p.digits, check = FALSE, output = FALSE)
#...................
### Data frame, correlation matrix, sample size, and p-values ####
x <- data.frame(.group = group, x)
#...................
### Missing data ####
attr(x, "missing") <- any(is.na(x))
cor.mat <- object.g1$result$cor
n.mat <- object.g1$result$n
stat.mat <- object.g1$result$stat
df.mat <- object.g1$result$df
p.mat <- object.g1$result$p
#...................
### Lower triangular: Group 1; Upper triangular: Group 2 ####
cor.mat[upper.tri(cor.mat)] <- object.g2$result$cor[upper.tri(object.g2$result$cor)]
n.mat[upper.tri(n.mat)] <- object.g2$result$n[upper.tri(object.g2$result$n)]
stat.mat[upper.tri(stat.mat)] <- object.g2$result$stat[upper.tri(object.g2$result$stat)]
df.mat[upper.tri(df.mat)] <- object.g2$result$df[upper.tri(object.g2$result$df)]
p.mat[upper.tri(p.mat)] <- object.g2$result$p[upper.tri(object.g2$result$p)]
}
#_____________________________________________________________________________
#
# Return Object --------------------------------------------------------------
object <- list(call = match.call(),
type = "cor.matrix",
data = x,
args = list(method = method, na.omit = na.omit,
sig = sig, alpha = alpha, print = print, tri = tri,
p.adj = p.adj, continuity = continuity, digits = digits,
p.digits = p.digits, as.na = as.na, write, check = check,
output = output),
result = list(cor = cor.mat, n = n.mat, stat = stat.mat, df = df.mat,p = p.mat))
class(object) <- "misty.object"
#_____________________________________________________________________________
#
# Write results --------------------------------------------------------------
if (isTRUE(!is.null(write))) { misty::write.result(object, file = write) }
#_____________________________________________________________________________
#
# Output ---------------------------------------------------------------------
if (isTRUE(output)) { print(object, check = FALSE) }
return(invisible(object))
}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.