Assess Overlap/Positivity from LMTP Models via Density Ratios
Source:R/margot_lmtp_overlap.R
margot_lmtp_overlap.RdSummarizes density-ratio overlap and effective sample size (ESS) for LMTP models using `margot_lmtp_positivity()`, and optionally creates diagnostic plots of the density-ratio distributions by wave and shift.
Usage
margot_lmtp_overlap(
x,
outcomes = NULL,
shifts = NULL,
plot = TRUE,
theme = "classic",
scale = "log10",
digits = 3,
verbose = TRUE,
color_by = c("wave", "shift", "constant"),
color_by_wave = NULL,
fill_palette = NULL,
bins = 40,
binwidth = NULL,
xlim = NULL,
...
)Arguments
- x
LMTP run output with `$models` (e.g., result from margot_lmtp()), or a list compatible with `margot_lmtp_positivity()`.
- outcomes
Optional character vector of outcome names to include.
- shifts
Optional character vector of shifts/policies to include (accepts full names like `t5_pwi_z_shift_up` or cleaned names like `shift_up`).
- plot
Logical; if TRUE, create ratio distribution plots.
- theme
ggplot2 theme keyword: "classic" (default), "minimal", "bw", "gray", "light", "dark", "void".
- scale
Character; x-axis scale for plotted ratios: "log10" (default) shows log10(density ratio) for w>0, or "linear" shows the raw ratio.
- digits
Integer rounding for summaries (passed to positivity helper).
- verbose
Logical; emit informative messages.
- color_by
Character; how to colour histogram fills: `"wave"` (default), `"shift"` (one colour per shift), or `"constant"` (single colour).
- color_by_wave
Legacy logical alias for `color_by` (`TRUE` = `"wave"`, `FALSE` = `"constant"`).
- fill_palette
Optional vector of colours (named or unnamed) used when colouring histograms. Character aliases include `"lab"` (blue/red/grey with a constant fallback) and `"classic"` (the default qualitative palette).
- ...
Ignored. Present for backward compatibility with older arguments like `save_plots` and `output_dir` that are being phased out.