estimate_pdiff_two: Estimate magnitude of difference between two independent...

In rcalinjageman/esci4: Effect Sizes and Confidence Intervals

Estimate magnitude of difference between two independent groups.

Description

\loadmathjax

estimate_pdiff_two returns effect sizes estimating difference between two independent measures of a proportion

Usage

estimate_pdiff_two(
  data = NULL,
  outcome_variable = NULL,
  grouping_variable = NULL,
  comparison_cases = NULL,
  comparison_n = NULL,
  reference_cases = NULL,
  reference_n = NULL,
  case_label = 1,
  not_case_label = NULL,
  grouping_variable_levels = NULL,
  outcome_variable_name = "My outcome variable",
  grouping_variable_name = "My grouping variable",
  conf_level = 0.95,
  count_NA = FALSE
)

Arguments

data	For raw data - a dataframe or tibble
outcome_variable	For raw data - The column name of the outcome variable which is a factor, or a vector that is a factor
grouping_variable	For raw data - The column name of the grouping variable which is a factor, or a vector that is a factor
comparison_cases	For summary data, a numeric integer >= 0
comparison_n	For summary data, a numeric integer >= comparison_events
reference_cases	For summary data, a numeric integer >= 0
reference_n	For summary data, a numeric integer >= reference_events
case_label	An optional numeric or character label for the case level.
not_case_label	An optional numeric or character label for the not case level.
grouping_variable_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_name	Optional friendly name for the grouping variable. Defaults to 'My grouping variable' 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.
count_NA	Logical to count NAs (TRUE) in total N or not (FALSE)

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_two(
 datasets::PlantGrowth[PlantGrowth$group != 'trt2', ],
 weight,
 group
)

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