treatment_effect {baggr} | R Documentation |
Average treatment effects in a baggr model
Description
The most general treatment_effect
displays
both hypermean and hyperSD (as a list of length 2),
whereas hypermean
and hypersd
can be used as shorthands.
Usage
treatment_effect(
bg,
summary = FALSE,
transform = NULL,
interval = 0.95,
message = TRUE
)
hypermean(
bg,
transform = NULL,
interval = 0.95,
message = FALSE,
summary = TRUE
)
hypersd(bg, transform = NULL, interval = 0.95, message = FALSE, summary = TRUE)
Arguments
bg |
a baggr model |
summary |
logical; if TRUE returns summary statistics as explained below. |
transform |
a transformation to apply to the result, should be an R function;
(this is commonly used when calling |
interval |
uncertainty interval width (numeric between 0 and 1), if summarising |
message |
logical; use to disable messages prompted by using with no pooling models |
Functions
-
treatment_effect()
: A list with 2 vectors (corresponding to MCMC samples)tau
(mean effect) andsigma_tau
(SD). Ifsummary=TRUE
, both vectors are summarised as mean and lower/upper bounds according tointerval
-
hypermean()
: The hypermean of abaggr
model, shorthand fortreatment_effect(x, s=T)[[1]]
-
hypersd()
: The hyper-SD of abaggr
model, shorthand fortreatment_effect(x, s=T)[[2]]