concstats_entropy {concstats}

Shannon Entropy

Description

Shannon Entropy

Usage

concstats_entropy(x, normalized = TRUE, na.rm = TRUE)

Arguments

x

A non-negative numeric vector.

normalized

Logical. Argument specifying whether or not a normalized value is required. Must be either TRUE or FALSE. The default is TRUE.

na.rm

A logical vector that indicates whether NA values should be excluded or not. Must be either TRUE or FALSE. The default is TRUE. If set to FALSE the computation yields NA if vector contains NA values.

Value

A single numeric measure.

References

Shannon, C. E. (1948). "A Mathematical Theory of Communication", The Bell System Technical Journal (Nokia Bell Labs).

Examples

# a vector of market shares
x <- c(0.4, 0.2, 0.25, 0.1, 0.05)
concstats_entropy(x, normalized = TRUE)
# a vector with NA values
x <- c(0.4, 0.2, 0.25, 0.1, 0.05, NA)
concstats_entropy(x, na.rm = FALSE)