metaAnalysis: Create a Meta-Analysis Object Using Data From Previous...

In imt: Impact Measurement Toolkit

Create a Meta-Analysis Object Using Data From Previous Studies

Description

Create a Meta-Analysis Object Using Data From Previous Studies

Create a Meta-Analysis Object Using Data From Previous Studies

Details

A meta analysis has raw data and draws from the lift's posterior distribution. This is represented by an R6 Class.

Active bindings

PosteriorATE

Draws from the posterior distribution of the average treatment effect.

checks

MCMC diagnostics

CredibleInterval

Lower and upper bounds of the credible interval

PointEstimate

Point estimate of the average treatment effect

fitted

Stan fit object

Methods

Public methods

• metaAnalysis$new()

• metaAnalysis$PlotRawData()

• metaAnalysis$PlotLift()

• metaAnalysis$UpdateCI()

• metaAnalysis$probability()

• metaAnalysis$findings()

• metaAnalysis$clone()

---

Method new()

Create a new meta analysis object.

Usage

metaAnalysis$new(
  data,
  point_estimates,
  standard_errors,
  id,
  mean_mu = 0,
  sd_mu = 0.05,
  ci_width = 0.75,
  X = NULL,
  run_estimation = 1,
  ...
)

Arguments

data

Data frame with data point estimates and standard errors from studies.

point_estimates

Name of the variable in the data frame that contains the point estimates.

standard_errors

Name of the variable in the data frame that contains the standard errors of the point estimates.

id

Name of the variable in the data frame that contains the id of the studies.

mean_mu

Prior mean for the true lift in the population.

sd_mu

Prior mean for the standard deviation of the true lift in the population.

ci_width

Credible interval's width.

X

Covariates matrix.

run_estimation

Integer flag to control whether estimation is run (1) or not (0).

...

other arguments passed to rstan::sampling()

Returns

A new meta_analysis object.

---

Method PlotRawData()

Plots the raw data.

Usage

metaAnalysis$PlotRawData()

Returns

A plot with point estimates and 95% confidence intervals.

---

Method PlotLift()

Plots lift's prior and posterior distributions.

For more details see vizdraws::vizdraws().

Usage

metaAnalysis$PlotLift(...)

Arguments

...

other arguments passed to vizdraws.

Returns

An interactive plot of the prior and posterior distributions.

---

Method UpdateCI()

Update the width of the credible interval.

Usage

metaAnalysis$UpdateCI(ci_width)

Arguments

ci_width

New width for the credible interval. This number in the (0,1) interval.

---

Method probability()

Calculates that probability that lift is between a and b.

Usage

metaAnalysis$probability(a = -Inf, b = Inf, percent = TRUE)

Arguments

a

Lower bound. By default -Inf.

b

Upper bound. By default Inf.

percent

A logical that indicates that a and b should be converted to percentage.

Returns

A string with the probability.

---

Method findings()

Calculates the point estimate a credible interval for the meta analysis.

Usage

metaAnalysis$findings(percent = TRUE)

Arguments

percent

A logical that indicates that the point estimate should be converted to percent.

Returns

A string with the findings

---

Method clone()

The objects of this class are cloneable with this method.

Usage

metaAnalysis$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

imt documentation built on Sept. 11, 2024, 5:41 p.m.