shannon.entropy: Calculate the Shannon entropy

View source: R/util-methods.r

shannon.entropyR Documentation

Calculate the Shannon entropy

Description

This function calculates the Shannon entropy for a discrete random variable with finite n values sample.

Usage

shannon.entropy(p)

Arguments

p

A numeric object with non-negative values.

Details

The entropy is calculated by H(x) = -sum_i^n(P(x_i)log_b(P(x_i))).

Value

A numeric value of entropy is returned.

Author(s)

Ge Tan

Examples

  x <- c(1, 1, 1, 1)
  shannon.entropy(x)
  x <- c(1, 0, 0, 0)
  shannon.entropy(x)

ge11232002/TFBSTools documentation built on Dec. 26, 2024, 12:38 a.m.