R/dispersion.R

Defines functions dispersion

Documented in dispersion

#' This function calculates the variance to mean ratio (also known as dispersion index).
#' @param x is a numeric vector.
#' @return Returns the dispersion index.

dispersion <- function(x) {
  var(x) / mean(x)
}
vpourfaraj/lobsterCatch documentation built on May 17, 2023, 1:37 p.m.