Interpret RATE estimates in markdown — margot_interpret

This function provides a concise interpretation of Rank-Weighted Average Treatment Effect (RATE) estimates from margot_rate(). The RATE ranks individuals by predicted treatment effects and computes average effects for selected percentiles.

Usage

margot_interpret_rate(rate_df, flipped_outcomes = NULL, target = "AUTOC")

Arguments

rate_df: A data frame from margot_rate() with columns: RATE Estimate, 2.5%, and 97.5%. First column contains outcome names.
flipped_outcomes: Character vector of outcome names that were inverted during pre-processing.
target: Character string specifying RATE type: AUTOC (default) or QINI.

Value

A markdown string interpreting statistically reliable RATE estimates.

Examples

if (FALSE) { # \dontrun{
interpretation <- margot_interpret_rate(rate_table, flipped_outcomes = c("t2_neuroticism_z"))
cat(interpretation)
} # }