CI_mdiff_one: Estimate the mean difference from a sample mean to a...

In rcalinjageman/esci2: Effect Sizes and Confidence Intervals

Description

\loadmathjax

CI_mdiff_one returns the point estimate and confidence interval for the mean difference between a sample mean and a population/reference mean \mjdeqn M_diff = X - \muMdiff = X - mu

Usage

CI_mdiff_one(
  comparison_m,
  comparison_s,
  comparison_n,
  population_m = 0,
  population_s = NULL,
  conf_level = 0.95
)

Arguments

comparison_m	Mean from the sample
comparison_s	Standard deviation from the sample
comparison_n	Sample size
population_m	Optional value for population mean; defaults to 0
population_s	Optional value for population sd; defaults to NULL. If NULL function returns a CI based on the sample sd and a t-distribution. If a numeric value is passed, returns a CI based on the population_sd and a z-distribution
conf_level	The confidence level in decimal form. Defaults to 0.95.

Value

Returns a list with these named elements:

• effect_size - Calculated as comparison_m - population_m

• lower - lower bound of the CI

• upper - upper bound of the CI

• df - degrees of freedom; NA if population_s is passed; otherwise comparison_n - 1

• se - standard error

• moe - margin of error

• variability_component - population_s if passed, otherwise comparison_s

Details

If population_s is passed:

• se = population_s / sqrt(comparison_n)

• MoE = se * z_critical

If population_s is NULL:

• se = comparison_s / sqrt(comparison_n)

• MoE = se * t_critical

Examples

  CI_mdiff_one(
    comparison_m = 10, 
    comparison_s = 3, 
    comparison_n = 25
  )   

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