byars_upper: byars_upper

Description Usage Arguments Value Notes References

View source: R/utils.R

Description

Calculates the upper confidence limits for observed numbers of events using Byar's method [1].

Usage

1
byars_upper(x, confidence = 0.95)

Arguments

x

the observed numbers of events; numeric vector; no default

confidence

the required level of confidence expressed as a number between 0.9 and 1 or a number between 90 and 100 or can be a vector of 0.95 and 0.998, for example, to output both 95% and 99.8% CIs; numeric; default 0.95

Value

Returns upper confidence limits for observed numbers of events using Byar's method [1]

Notes

This is an internal package function that is appropriately called by exported 'phe_' prefixed functions within the PHEindicatormethods package.

byars_lower and byars_upper together return symmetric confidence intervals around counts, therefore for a specified confidence level, α, the probability that, by chance, the upper limit returned will be below the true underlying value, is α/2.

References

[1] Breslow NE, Day NE. Statistical methods in cancer research, volume II: The design and analysis of cohort studies. Lyon: International Agency for Research on Cancer, World Health Organisation; 1987.

————————————————————————————————-


PHEindicatormethods documentation built on July 1, 2020, 6:01 p.m.