shapeEntropy {CAGEfightR} | R Documentation

## Shape statistic: Shannon Entropy

### Description

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

### Usage

    shapeEntropy(x)

### Arguments

`x` | numeric Rle vector: Coverage series.

### Value

Numeric.

### See Also

Other Shape functions: `calcShape`, `shapeIQR`, `shapeMultimodality`

### Examples

    # 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

[Package CAGEfightR version 1.2.0 Index]