estimate_mdiff_2x2_between: Estimate the magnitude of difference for an independent...

View source: R/estimate_mdiff_2x2_between.R

estimate_mdiff_2x2_betweenR Documentation

Estimate the magnitude of difference for an independent groups contrast.

Description

\loadmathjax

estimate_mdiff_2x2_between returns point estimate and confidence intervals for a 2x2 fully between-subjects design

Usage

estimate_mdiff_2x2_between(
  data = NULL,
  outcome_variable = NULL,
  grouping_variable_A = NULL,
  grouping_variable_B = NULL,
  means = NULL,
  sds = NULL,
  ns = NULL,
  grouping_variable_A_levels = NULL,
  grouping_variable_B_levels = NULL,
  outcome_variable_name = "My outcome variable",
  grouping_variable_A_name = "A",
  grouping_variable_B_name = "A",
  conf_level = 0.95,
  assume_equal_variance = FALSE,
  save_raw_data = TRUE
)

Arguments

data

For raw data - a dataframe or tibble

outcome_variable

For raw data - The column name of the outcome variable, or a vector of numeric data

grouping_variable_A

For raw data - The column name of the grouping variable, or a vector of group names, only 2 levels allowed

grouping_variable_B

For raw data - The column name of the grouping variable, or a vector of group names, only 2 levels allowed

means

For summary data - A vector of 4 means: A1B1, A1B2, A2B1, A2B2

sds

For summary data - A vector of 4 standard deviations, same order

ns

For summary data - A vector of 4 sample sizes

grouping_variable_A_levels

For summary data - An optional vector of 2 group labels

grouping_variable_B_levels

For summary data - An optional vector of 2 group labels

outcome_variable_name

Optional friendly name for the outcome variable. Defaults to 'My outcome variable' or the outcome variable column name if a data frame is passed.

grouping_variable_A_name

Optional friendly name for the grouping variable. Defaults to 'A' or the grouping variable column name if a data.frame is passed.

grouping_variable_B_name

Optional friendly name for the grouping variable. Defaults to 'A' or the grouping variable column name if a data.frame is passed.

conf_level

The confidence level for the confidence interval. Given in decimal form. Defaults to 0.95.

assume_equal_variance

Defaults to FALSE

save_raw_data

For raw data; defaults to TRUE; set to FALSE to save memory by not returning raw data in estimate object

Value

Returnsobject of class esci_estimate

Examples

# From Raw Data ------------------------------------
# Just pass in the data source, grouping column, and outcome column.
# You can pass these in by position, skipping the labels:

# Note... not sure if PlantGrowth dataset meets assumptions for this analysis
estimate_mdiff_2x2_between(

)


rcalinjageman/esci4 documentation built on May 18, 2023, 4:01 a.m.