Nothing
#' @title Biweight Midcorrelation
#'
#' @description
#' This function computes the biweight midcorrelation between two numeric vectors.
#' The biweight midcorrelation is a robust measure of correlation that is less
#' sensitive to outliers than the traditional Pearson's correlation coefficient.
#'
#' @details
#' The biweight midcorrelation is calculated using the biweight midvariances
#' and biweight midcovariance, as described by Wilcox (1994). It is bounded
#' between -1 and 1.
#'
#' @references
#' - Wilcox, R. R. (1994).
#' The Biweight Midcorrelation: A Robust Correlation Technique for Two Samples.
#' Journal of Statistical Computation and Simulation, 48(2):103-110.
#'
#' @author Christian L. Goueguel
#' @param x A numeric vector.
#' @param y A numeric vector of the same length as `x`.
#'
#' @return The biweight midcorrelation between `x` and `y`.
#'
#' @examples
#' data(forageLIBS)
#' ok <- !is.na(forageLIBS$Fe)
#' c(pearson = stats::cor(forageLIBS$Fe[ok], forageLIBS$Mn[ok]),
#' biweight = biweight_midcorrelation(forageLIBS$Fe[ok], forageLIBS$Mn[ok]))
#'
#' @export biweight_midcorrelation
#'
biweight_midcorrelation <- function(x, y) {
check_bivariate(x, y)
if (anyNA(x) || anyNA(y)) {
return(NA_real_)
}
wx <- biweight_terms(x)
wy <- biweight_terms(y)
if (is.null(wx) || is.null(wy)) {
return(NA_real_)
}
return(sum(wx$a * wy$a) / sqrt(sum(wx$a^2) * sum(wy$a^2)))
}
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.