shannon {benthos}R Documentation

Shannon's Index or Entropy

Description

Compute entropy according to Shannon (1948)

Usage

shannon(.data = NULL, taxon, count, base = 2)

shannon_(.data = NULL, taxon, count, base = 2)

Arguments

.data

data in a data.frame, data_frame, data.table, database etc.

taxon

taxa names (character)

count

counts (numeric)

base

the base with respect to which logarithms are computed. Defaults to 2.

Value

Shannon's entropy

Functions

References

Shannon, C. E., 1948. A Mathematical Theory of Communication. Bell System Technical Journal 27: 379-423.

Examples

 shannon(
     taxon = c("Euspira pulchella", "Nephtys cirrosa"), 
     count = c(4, 6)
 )


[Package benthos version 1.3-6 Index]