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

View source: R/refactoredCode.R

calculateDiscreteContinuousMI_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

calculateDiscreteContinuousMI_Compression(
  df,
  discreteVars,
  continuousVar,
  collect = FALSE,
  ...
)

Arguments

df

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

discreteVars

- the column(s) of the categorical value (X) quoted by vars(...)

continuousVar

- the column of the continuous value (Y)

collect

- unless TRUE this function will fail on dbplyr tables as there is no SQL implementation

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.