Arguments
idx
the index of the cell which corresponds to the interaction going to be esimated.
method
a character string indicating which estimate is to be computed.
One of "ML"
(Maximum Likelihood Estimator, default), "MM"
(Miller-Madow
corrected Estimator), "Bayes"
(Bayesian Estimators), "CS"
(Chao-Shen Estimator), "Shrink"
(James-Stein shrinkage Estimator),
"KD"
(kernel Density Estimator), or "KNN"
(k-Nearest Neighbor
Estimator), can be abbreviated. For the "Bayes"
estimate it is needed
to specify also which priorHyperParam
is to be used; for "Shrink"
is optional to specify values for the shrinkageTarget
parameter; for
"KNN"
is needed to specify also the number of nearest neighbors k
.
unit
the unit in which mutual information is measured. One of "bit"
(log2, default), "ban"
(log10) or "nat"
(natural units).
priorHyperParam
the prior distribution type for the Bayes estimation. One of "Jeffreys"
(default, Jeffreys Prior, Krichevsky and Trofimov Estimator), "BLUnif"
(Bayes-Laplace uniform Prior, Holste Estimator), "Perks"
(Perks Prior,
Schurmann and Grassberger Estimator), or "MiniMax"
(MiniMax Prior), can be
abbreviated.
shrinkageTarget
shrinkage target frequencies. If not specified (default) it is estimated in
a James-Stein-type fashion (uniform distribution).
boot
logical (FALSE
as default). Used for calculating a null distribution
in order to evaluate if such a interaction is true or obtained by chance.