shannon_proportion_index: Compute the Shannon index from a table of contributions
In BigelowLab/dismotools: dismotools

shannon_proportion_index

R Documentation

Compute the Shannon index from a table of contributions

Compute the Shannon index from a table of contributions

shannon_proportion_index(x, base = exp(1), offset = c(1e-05, NA)[1])

`x`	table or matrix of observations. If a matrix then, like a table, columns are variables and rows are records.
`base`	numeric, the base of the logarithm
`offset`	numeric, a small value to prevent taking the log of zero. If `offset` is NA or less than or equal to zero then zero-valued elements are removed. if `offset` greater than zero, then zero-valued elements in x are replaced with this value.

vector of Shannon index - one element for each record