ppv: Positive Predictive Value

Description Usage Arguments Details Value References Examples

Description

Calculates positive predictive value given the effect size, power, and alpha level.

Usage

1
ppv(effectSize, power, alpha)

Arguments

effectSize

the quantitative measure of the strength of a phenomenon in an experiment, between 0 and 1

power

probability that the test correctly rejects the null hypothesis when the alternative hypothesis is true

alpha

false positive value or Type I error

Details

The positive predictive value is the fraction of true positives out of positive labeled classes (i.e. true positive and false positive).

Value

positive predictive value

References

Krzywinski, Martin, and Naomi Altman. "Points of significance: Power and sample size." Nature Methods 10.12 (2013): 1139-1140.

Examples

1
2
3
ppv(effectSize = 0.5, power = 0.2, alpha = 0.05)
ppv(effectSize = 0.5, power = 0.5, alpha = 0.05)
ppv(effectSize = 0.5, power = 0.8, alpha = 0.05)

erictleung/poofsi documentation built on May 16, 2019, 8:41 a.m.