Skip to contents

Produce a compact Markdown summary describing which outcomes show positive, negative, or inconclusive heterogeneous treatment effects.

Usage

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

Arguments

rate_df

A data frame from margot_rate() or a list containing rate_autoc and rate_qini.

flipped_outcomes

Character vector of outcomes inverted during preprocessing.

target

Character; either "AUTOC" or "QINI" (ignored when rate_df is a list).

adjust_positives_only

Logical; if TRUE, apply multiple testing correction only to positive RATEs in comparison output. Default FALSE.

Value

If rate_df is a data frame, a Markdown string. If rate_df is a list, returns a list produced by margot_interpret_rate_comparison().