R/mean_corr.R

In jazznbass/wmisc: Wilbert miscellaneous functions

#' Average correlations by Fisher Z transformation
#'
#' @param r A vector of correlation coefficients
#'
#' @return The average correlation
#' @examples
#' rs <- c(0.2, 0.5, 0.9)
#' mean(rs)
#' mean_corr(rs)
#' @export

mean_corr <- function(r) {
  z <- 0.5 * log((1 + r) / (1 - r))
  mz <- mean(z, na.rm = TRUE)
  (exp(2 * mz) - 1) / (exp(2 * mz) + 1)
}