forest.orbbound: Forest plot for 'orbbound' object (bound for outcome...

View source: R/forest.orbbound.R

forest.orbboundR Documentation

Forest plot for orbbound object (bound for outcome reporting bias)

Description

Draws a forest plot in the active graphics window (using grid graphics system).

Usage

## S3 method for class 'orbbound'
forest(
  x,
  common = x$x$common,
  random = x$x$random,
  text.common = "CE model",
  text.random = "RE model",
  smlab = NULL,
  leftcols = c("studlab", "maxbias"),
  leftlabs = c("Missing\nstudies", "Maximum\nbias"),
  backtransf = x$backtransf,
  digits = max(3, .Options$digits - 3),
  warn.deprecated = gs("warn.deprecated"),
  ...
)

Arguments

x

An object of class orbbound.

common

A logical indicating whether sensitivity analysis for common effect model should be plotted.

random

A logical indicating whether sensitivity analysis for random effects model should be plotted.

text.common

A character string used in the plot to label subgroup with results for common effect model.

text.random

A character string used in the plot to label subgroup with results for random effects model.

smlab

A label printed at top of figure. If only results for either common effect or random effects model is plotted, text indicates which model was used.

leftcols

A character vector specifying (additional) columns to be plotted on the left side of the forest plot or a logical value (see forest.meta help page for details).

leftlabs

A character vector specifying labels for (additional) columns on left side of the forest plot (see forest.meta help page for details).

backtransf

A logical indicating whether results should be back transformed in printouts and plots. If backtransf=TRUE (default), results for sm="OR" are printed as odds ratios rather than log odds ratio, for example.

digits

Minimal number of significant digits, see print.default.

warn.deprecated

A logical indicating whether warnings should be printed if deprecated arguments are used.

...

Additional arguments for forest.meta function and to catch deprecated arguments.

Details

A forest plot, also called confidence interval plot, is drawn in the active graphics window.

For relative effect measures, e.g., 'RR', 'OR', and 'HR', the column labeled "Maximum bias" contains the relative bias, e.g. a value of 1.10 means a maximum overestimation by 10 percent. If backtransf=FALSE for these summary measures, maximum bias is instead printed as absolute bias.

Internally, R function forest.meta is called to create a forest plot. For more information see help page of the forest.meta function.

Author(s)

Guido Schwarzer guido.schwarzer@uniklinik-freiburg.de

See Also

orbbound, print.orbbound

Examples

data(Fleiss1993bin, package = "meta")

m1 <- metabin(d.asp, n.asp, d.plac, n.plac, data = Fleiss1993bin, sm = "OR")

orb1 <- orbbound(m1, k.suspect = 1:5)
print(orb1, digits = 2)
forest(orb1, xlim = c(0.7, 1.5))
## Not run: forest(orb1, backtransf = FALSE)


metasens documentation built on March 7, 2023, 7:51 p.m.