calculateDiscreteEntropy_InfoTheo: calculate entropy of an optionally discrete value (X) using a...

In terminological/tidy-info-stats: Functions for manipulating information statistics

calculate entropy of an optionally discrete value (X) using a infotheo library

Description

calculate entropy of an optionally discrete value (X) using a infotheo library

Usage

calculateDiscreteEntropy_InfoTheo(
  df,
  groupVars,
  infoTheoMethod = "mm",
  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)
infoTheoMethod	- the method of the entropy estimator ("mm","emp","shrink","sg")
collect	- if false (the default) this will fail on a dbplyr table as this is not supported in SQL

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.