R/shannon.R

Defines functions shannon

Documented in shannon

#' Shannon Diversity index
#'
#' @param x vector
#' @export
#'
shannon <- function(x) {
  x <- x[!is.na(x) & x > 0]
  # estimate proportions
  prop <- x/sum(x)
  # estimate variation
  var <- sum(prop*log2(prop))*-1
  return(var)
}
mottensmann/DBChecks documentation built on Feb. 3, 2022, 9:21 p.m.