treatment_effect: Average treatment effect in a baggr model

View source: R/trt_effects.R

treatment_effectR Documentation

Average treatment effect in a baggr model

Description

Average treatment effect in a baggr model

Usage

treatment_effect(
  bg,
  summary = FALSE,
  transform = NULL,
  interval = 0.95,
  message = 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 treatment_effect from other plotting or printing functions)

interval

uncertainty interval width (numeric between 0 and 1), if summarising

message

logical; use to disable messages prompted by using with no pooling models

Value

A list with 2 vectors (corresponding to MCMC samples) tau (mean effect) and sigma_tau (SD). If summary=TRUE, both vectors are summarised as mean and lower/upper bounds according to interval


baggr documentation built on March 18, 2022, 7:02 p.m.