R/inverse_simpson.R

In compbiomed/animalcules: Interactive microbiome analysis toolkit

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


# x: Species count vector
inverse_simpson <- function(x) {
    # Simpson index
    lambda <- simpson_index(x)
    
    # Inverse Simpson diversity
    (1 / lambda)
}