shapeEntropy: Shape statistic: Shannon Entropy

Description Usage Arguments Value See Also Examples

View source: R/shape.R

Description

Calculates the Shannon Entropy (base log2) for a vector. Zeros are removed before calculation.

Usage

1

Arguments

x

numeric Rle vector: Coverage series.

Value

Numeric.

See Also

Other Shape functions: calcShape(), shapeIQR(), shapeMean()

Examples

1
2
3
4
5
6
7
8
9
# Hypothetical shard/broad clusters:
x_sharp <- Rle(c(1,1,1,4,5,2,1,1))
x_broad <- Rle(c(1,2,3,5,4,3,2,1))

# Calculate Entropy
shapeEntropy(x_sharp)
shapeEntropy(x_broad)

# See calcShape for more usage examples

MalteThodberg/CAGEfightR documentation built on Sept. 11, 2021, 4:42 a.m.