R/gini.R

In Accio/BioQC: Detect tissue heterogeneity in expression profiles with gene sets

#'Calculate Gini Index of a numeric vector
#'
#'Calculate the Gini index of a numeric vector.
#'
#'@param x A numeric vector.
#'
#'@details The Gini index (Gini coefficient) is a measure of statistical dispersion. A Gini
#'coefficient of zero expresses perfect equality where all values are
#'the same. A Gini coefficient of one expresses maximal inequality among values.
#'
#'@return A numeric value between 0 and 1.
#'
#'@references Gini. C. (1912) \emph{Variability and Mutability}, C. Cuppini, Bologna
#'156 pages.
#'
#'@author Jitao David Zhang <jitao_david.zhang@roche.com>
#'
#'@examples 
#'testValues <- runif(100)
#'gini(testValues)
#'@export
gini <- function(x)  {
    storage.mode(x) <- "double"
    hasNeg <- any(x<0)
    if(!is.na(hasNeg) & hasNeg)
      stop("Gini index is only applicable to non-negative values!")
    isVec <- !is.matrix(x)
    if(isVec) {
        x <- x[!is.na(x)]
        x <- sort(x, decreasing=FALSE)
        res <- .Call(C_gini_numeric, x, length(x))
    } else {
        res <- .Call(C_gini_matrix, x, nrow(x), ncol(x))
    }
    return(res)
}