Create a summary table for a one-sample mean hypothesis test

Usage

infer_1mean_test(
  data,
  formula,
  digits = 3,
  mu0 = 0,
  alternative = c("notequal", "greater", "less"),
  conf_lvl = 0.95,
  caption = NULL
)

Arguments

data: A data frame (or tibble).
formula: The variable to run the test on, in formula syntax, ~var.
digits: The number of digits to round table values to. Defaults to 3.
mu0: The null hypothesis value. Defaults to 0.
alternative: The alternative hypothesis. Defaults to "notequal" (two sided p-value). Other options include "greater" or "less". Use depends on your test.
conf_lvl: The confidence level of the interval, entered as a value between 0 and 1. Defaults to 0.95.
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_1mean_test(mtcars, ~wt)
infer_1mean_test(mtcars, ~wt, alternative = "less")
infer_1mean_test(mtcars, ~wt, mu0 = 3)
infer_1mean_test(mtcars, ~wt, digits = 4, conf_lvl = 0.90)