calculateDiscreteEntropy_Compression: calculate mutual information between a categorical value (X)...

View source: R/tidyDiscreteEntropy.R

calculateDiscreteEntropy_CompressionR Documentation

calculate mutual information between a categorical value (X) and a continuous value (Y) using a compression algorithm based on.

Description

Universal and accessible entropy estimation using a compression algorithm Ram Avinery, Micha Kornreich, Roy Beck https://arxiv.org/abs/1709.10164

Usage

calculateDiscreteEntropy_Compression(
  df,
  groupVars,
  orderingVar = NULL,
  collect = FALSE,
  ...
)

Arguments

df

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

groupVars

- the column of the discrete value (X)

orderingVar

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

collect

- if TRUE will collect dbplyr tables before processing, otherwise (the default) will fail on dbplyr tables

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.