R/simpson_index.R

Defines functions simpson_index

Documented in simpson_index

#' Get alpha diversity using simpson
#'
#' @param x A list of counts
#' @return A single value
#'
#' @examples
#' simpson_index(seq_len(10))
#'
#' @export

simpson_index <- function(x) {
    # Relative abundances
    p <- x / sum(x)
    
    # Simpson index
    lambda <- sum(p^2)
    
    lambda
}
compbiomed/animalcules documentation built on Feb. 7, 2024, 12:13 p.m.