estimate_mdiff_one: Estimate the difference between a sample mean and known...

In rcalinjageman/esci2: Effect Sizes and Confidence Intervals

Description

This function estimates a mean difference from a sample mean and known population mean, returning a point estimate and a frequentist confidence interval. It can be called with raw data or summary data

Usage

estimate_mdiff_one(
  data = NULL,
  outcome_variable = NULL,
  comparison_m = NULL,
  comparison_s = NULL,
  comparison_n = NULL,
  population_m = 0,
  population_s = NULL,
  outcome_variable_name = "My outcome variable",
  conf_level = 0.95,
  save_raw_data = TRUE
)

Arguments

data	For raw data - a dataframe or tibble
outcome_variable	For raw data - The name of the column to analyze or a vector of numeric data
comparison_m	For summary data - The sample mean
comparison_s	For summary data - The sample standard deviation
comparison_n	For summary data - The sample size
population_m	Known population mean; Effect size is comparison_m - population_m; defaults to 0
population_s	Population standard deviation
outcome_variable_name	For summary data - Optional label, defaults to 'My outcome variable'
conf_level	The confidence level for the confidence interval. Given in decimal form. Defaults to 0.95.
save_raw_data	For raw data; defaults to TRUE; set to false to save memory by not returning raw data in estimate object Output:

Value

An object of class esci_estimate

rcalinjageman/esci2 documentation built on Dec. 22, 2021, 1:02 p.m.