calculateDiscreteEntropy_MontgomerySmith: calculate entropy of an optionally ordered discrete value (X)...

View source: R/tidyDiscreteEntropy.R

calculateDiscreteEntropy_MontgomerySmithR Documentation

calculate entropy of an optionally ordered discrete value (X) using estimates of entropy from method 2 in the following:

Description

S. Montgomery-Smith and T. Schürmann, “Unbiased Estimators for Entropy and Class Number,” arXiv, 18-Oct-2014. Available: http://arxiv.org/abs/1410.5002

Usage

calculateDiscreteEntropy_MontgomerySmith(
  df,
  groupVars,
  orderingVar = NULL,
  ...
)

Arguments

df

- may be grouped, in which case the grouping is interpreted as different types of discrete variable

groupVars

- the columns of the discrete value quoted by the vars() function (e.g. ggplot facet_wrap)

orderingVar

- (optional) the column of an ordering variable (e.g. time) - if missing assumes df order,

Details

This is not particularly useful as requires large sample size before it becomes accurate.

Value

a dataframe containing the disctinct values of the groups of df, and for each group an entropy value (H). If df was not grouped this will be a single entry


terminological/tidy-info-stats documentation built on Nov. 19, 2022, 11:23 p.m.