permutation_entropy: A function to compute the permutation entropy

Description Usage Arguments Details Value Author(s) References Examples

View source: R/complexity_measures.R

Description

Computation of the permutation entropy of a time series based on its ordinal pattern distribution (see Bandt and Pompe 2002). Permutation entropy is a global information measure, hence insensitive to the permutation ordering scheme.

Usage

1

Arguments

opd

A numeric vector that details an ordinal pattern distribution.

Details

This function calculates the permutation entropy as described in Bandt and Pompe 2002.

Value

The normalized permutation entropy as a numeric value in the range [0,1].

Author(s)

Sebastian Sippel

References

Bandt, C. and Pompe, B., 2002. Permutation entropy: a natural complexity measure for time series. Physical review letters, 88(17), p.174102.

Examples

1
2
3
x = arima.sim(model=list(ar = 0.3), n = 10^4)
opd = ordinal_pattern_distribution(x = x, ndemb = 6)
permutation_entropy(opd)

Example output

[1] 0.9814997

statcomp documentation built on May 31, 2017, 3:02 a.m.