Create a summary table for a two-sample proportion test

Usage

infer_2prop_test(
  data,
  formula,
  success,
  digits = 3,
  conf_lvl = 0.95,
  alternative = c("notequal", "greater", "less"),
  caption = NULL
)

Arguments

data: A data frame (or tibble).
formula: The variables to run the test on, in formula syntax, var1 ~ var2.
success: The data value that constitutes a "success".
digits: The number of digits to round table values to. Defaults to 3.
conf_lvl: The confidence level of the interval, entered as a value between 0 and 1. Defaults to 0.95.
alternative: The alternative hypothesis. Defaults to "notequal" (two sided p-value). Other options include "greater" or "less". Use depends on your test.
caption: An override to the table caption. A sensible default is provided.

Value

An object of class flextable. In an interactive environment, results are viewable immediately.

Examples

infer_2prop_test(mtcars, vs~am, success = 1)
infer_2prop_test(mtcars, vs~am, success = 1, alternative = "less")
infer_2prop_test(mtcars, vs~am, success = 1, conf_lvl = .9, digits = 4)