mine_stat: Function to compute one measure at time

Description Usage Arguments Examples

View source: R/mine_onemeasure.R

Description

Function to compute one measure at time

Usage

1
2
mine_stat(x, y, alpha = 0.6, C = 15, est = "mic_approx",
  measure = "mic", eps = NULL, p = -1, norm = FALSE)

Arguments

x

a numeric vector (of size n), matrix or data frame (which is coerced to matrix).

y

NULL (default) or a numeric vector of size n (i.e., with compatible dimensions to x).

alpha

an optional number of cells allowed in the X-by-Y search-grid. Default value is 0.6 (see Details).

C

an optional number determining the starting point of the X-by-Y search-grid. When trying to partition the x-axis into X columns, the algorithm will start with at most CX clumps. Default value is 15 (see Details).

est

Default value is "mic_approx". With est="mic_approx" the original MINE statistics will be computed, with est="mic_e" the equicharacteristic matrix is is evaluated and the mic() and tic() methods will return MIC_e and TIC_e values respectively.

measure

character indicating the measure to extract. Default value "mic". Availiable values are: "mic", "mas", "mev", "mcn", "tic", "gmic".

eps

integer in [0,1]. If 'NULL' (default) it is set to 1-MIC. It can be set to zero for noiseless functions, but the default choice is the most appropriate parametrization for general cases (as stated in Reshef et al. SOM). It provides robustness.

p

probability for the generalized 'mic'

norm

boolean if require normalization between 0 and 1 for the 'tic' statistic

Examples

1
2
x <- runif(10); y <- 3*x+2;
mine_stat(x,y, measure="mic")

minerva documentation built on Dec. 14, 2018, 5:04 p.m.