calculateDiscreteDiscreteMI_Entropy: calculate mutual information between a discrete value (X) and...

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

calculate mutual information between a discrete value (X) and a discrete value (Y) using estimates of entropy

Description

calculate mutual information between a discrete value (X) and a discrete value (Y) using estimates of entropy

Usage

calculateDiscreteDiscreteMI_Entropy(
  df,
  groupXVars,
  groupYVars,
  entropyMethod = "Grassberger",
  ...
)

Arguments

df	- may be grouped, in which case the grouping is interpreted as different types of discrete variable
groupXVars	- the column of the discrete value (X) quoted by vars(...)
groupYVars	- the column of the discrete value (Y)
entropyMethod	- the method used to calculate the entropy (see ?tidyinfostats::calculateDiscreteEntropy) - defaults to "Grassberger"

Value

a dataframe containing the disctinct values of the groups of df, and for each group a mutual information column (I). 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.