GetMaxDValueForAThreeByTwoFamily: get maximum D value for three-by-two a family

In CausalR: Causal network analysis methods

Description

Returns the maximum D value for a particular family as described as D_fam on pages 6 and 7 of Assessing Statistical Significance of Causal Graphs in Assessing Statistical Signifcance of Causal Graphs

Usage

GetMaxDValueForAThreeByTwoFamily(r_p, r_m, r_z, n_p, n_m, predictionListStats,
  logOfFactorialOfPredictionListStats, returnlog = FALSE)

Arguments

r_p	a r+ row sum from the prediction-observation matrix
r_m	a r- row sum from the prediction-observation matrix
r_z	a r0 row sum from the prediction-observation matrix
n_p	a number of predicted increases from the prediction-observation matrix
n_m	a number of predicted decreases from the prediction-observation matrix
predictionListStats	a vector contain the number of postive, negative and non-significant/contradictory predictions: q+, q- and q0.
logOfFactorialOfPredictionListStats	a vector containing the log of the factorial for each element in the predictionListStats object
returnlog	whether or not the maximum D value should be returned as a log (TRUE). Otherwise a non-logged value is returned.

Value

Maximum D_fam Value

References

L Chindelevitch et al. Assessing statistical significance in causal graphs. BMC Bioinformatics, 13(35), 2012.

CausalR documentation built on Nov. 8, 2020, 5:25 p.m.