upper_corr {CompAREdesign}

R Documentation

Upper bound for Pearson's Correlation

Description

Pearson's correlation between two binary outcomes takes values between two bounds defined according to the probabilities of the binary outcomes. This function calculates the upper bound of the correlation based on the probabilities of two binary outcomes.

Usage

upper_corr(p_e1, p_e2)

Arguments

p_e1	numeric parameter, probability of the event E1
p_e2	numeric parameter, probability of the event E2

Details

upper_corr returns a numeric value between 0 and 1.

Value

Returns the maximum value that the correlation between the two outcomes can take.

Examples

CompAREdesign::upper_corr(p_e1=0.3, p_e2=0.6)

---