estimate_magnitude: Estimate a magnitude.

In rcalinjageman/esci4: Effect Sizes and Confidence Intervals

Estimate a magnitude.

Description

Returns effect sizes appropriate for estimating properties from a quantitative variable.

Usage

estimate_magnitude(
  data = NULL,
  outcome_variable = NULL,
  mean = NULL,
  sd = NULL,
  n = 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 column name of the outcome variable, or a vector of numeric data
mean	For summary data - A numeric
sd	For summary data - A numeric > 0
n	For summary data - An integer > 0
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.
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

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_magnitude(
 datasets::PlantGrowth,
 weight
)

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