epi_binom: Binomial estimates from dataframe column

In ianhandel/epidemr: Tidy Epidemiology in R

Binomial estimates from dataframe column

Description

A wrapper for binom::binom.confint called with a data.frame and unquoted columns or expressions.

Usage

epi_binom(x, y, conf_level = 0.95, methods = "all", digits, ...)

Arguments

x	A dataframe or number of sucesses
y	An expression evaluating to TRUE/FALSE or number of trials
conf_level	Probability for confidence interval calculations
methods	Confidence interval method see ?binom::binom.confint
digits	Rounding digits
...	Additional arguments for binom::binom.confint "bayes" method

Details

Given a column of a dataframe (and 'positive' level) generate a binomial proportion estimate and confidence intervals

Value

Returns an epi_binom object - this includes a variable for conf_level.

Examples

head(mtcars)
epi_binom(mtcars, cyl==4, conf_level = 0.95, methods = "all")
epi_binom(7, 10, conf_level = 0.95, methods = "all")

ianhandel/epidemr documentation built on April 13, 2022, 11:08 a.m.