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

View source: R/tidyDiscreteContinuousMI.R

calculateDiscreteContinuousMI_DiscretiseR Documentation

calculate mutual information between a categorical value (X) and a continuous value (Y) using a discretisation and calculateDiscreteDiscreteMI()

Description

calculate mutual information between a categorical value (X) and a continuous value (Y) using a discretisation and calculateDiscreteDiscreteMI()

Usage

calculateDiscreteContinuousMI_Discretise(
  df,
  discreteVars,
  continuousVar,
  discretiseMethod = "ByValue",
  mutualInfoMethod = "Histogram",
  ...
)

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)

discretiseMethod

- What method will be used to discretise the data? (ByRank, ByValue, Manual)

mutualInfoMethod

- What method will be used to calculate the MI once discretised?

...

- other parameters passed onto discretisation and mutual info methods

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.