forest.metainf: Forest plot to display the result of a leave-one-out...
In meta: General Package for Meta-Analysis

forest.metainf

R Documentation

Forest plot to display the result of a leave-one-out meta-analysis

Description

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

Usage

## S3 method for class 'metainf'
forest(
  x,
  leftcols = NULL,
  leftlabs = NULL,
  rightcols = NULL,
  rightlabs = NULL,
  prediction = x$prediction,
  overall = x$overall,
  just.addcols = "right",
  smlab = "Leave-One-Out Meta-Analysis",
  type = "square",
  lab.NA = ".",
  backtransf = x$backtransf,
  big.mark = gs("big.mark"),
  digits = gs("digits.forest"),
  digits.pval = gs("digits.pval"),
  digits.tau2 = gs("digits.tau2"),
  digits.tau = gs("digits.tau"),
  digits.I2 = gs("digits.I2"),
  digits.cid = gs("digits.cid"),
  digits.percent = 1,
  col = gs("col.study"),
  col.bg = ifelse(type == "diamond", gs("col.diamond"), gs("col.square")),
  col.border = ifelse(type == "diamond", gs("col.diamond.lines"), gs("col.square.lines")),
  col.bg.predict = gs("col.predict"),
  col.border.predict = gs("col.predict.lines"),
  addrows.below.overall = 1L * details,
  details = gs("forest.details"),
  ...
)

Arguments

`x`	An object of class `metainf`.
`leftcols`	A character vector specifying (additional) columns to be plotted on the left side of the forest plot or a logical value.
`leftlabs`	A character vector specifying labels for (additional) columns on left side of the forest plot.
`rightcols`	A character vector specifying (additional) columns to be plotted on the right side of the forest plot or a logical value.
`rightlabs`	A character vector specifying labels for (additional) columns on right side of the forest plot.
`prediction`	A logical indicating whether prediction intervals should be printed.
`overall`	A logical indicating whether overall results should be shown.
`just.addcols`	Justification of text for additional columns (possible values: "left", "right", "center").
`smlab`	A label for the summary measure (printed at top of figure).
`type`	A character string or vector specifying how to plot treatment effects and confidence intervals for cumulative meta-analysis results.
`lab.NA`	A character string to label missing values.
`backtransf`	A logical indicating whether results should be back transformed in forest plots. If `backtransf = TRUE`, results for `sm = "OR"` are presented as odds ratios rather than log odds ratios, for example.
`big.mark`	A character used as thousands separator.
`digits`	Minimal number of significant digits for treatment effects, see `print.default`.
`digits.pval`	Minimal number of significant digits for p-values.
`digits.tau2`	Minimal number of significant digits for between-study variance.
`digits.tau`	Minimal number of significant digits for square root of between-study variance.
`digits.I2`	Minimal number of significant digits for I-squared statistic.
`digits.cid`	Minimal number of significant digits for CID / decision thresholds, see `print.default`.
`digits.percent`	Minimal number of significant digits for probabilities, printed as percentages, see `print.default`.
`col`	The colour for cumulative meta-analysis results (only considered if `type = "square"`).
`col.bg`	The background colour for squares and diamonds of cumulative meta-analysis results.
`col.border`	The colour for the outer lines of squares and diamonds of cumulative meta-analysis results.
`col.bg.predict`	The background colour for prediction intervals of cumulative meta-analysis results.
`col.border.predict`	The colour for the outer lines of prediction intervals of cumulative meta-analysis results.
`addrows.below.overall`	A numeric value indicating how many empty rows are printed between meta-analysis results and meta-analysis details.
`details`	A logical specifying whether details on statistical methods should be printed.
`...`	Additional graphical arguments (passed on to `forest.meta`).

Details

A forest plot, also called confidence interval plot, is drawn in the active graphics window. The forest functions in R package meta are based on the grid graphics system. In order to print the forest plot, resize the graphics window and either use dev.copy2eps or dev.copy2pdf. Another possibility is to create a file using pdf, png, or svg and to specify the width and height of the graphic (see forest.meta examples).

The arguments leftcols and rightcols can be used to specify columns which are plotted on the left and right side of the forest plot, respectively.

The arguments leftlabs and rightlabs can be used to specify column headings which are plotted on left and right side of the forest plot, respectively. For certain columns predefined labels exist. For other columns, the column name will be used as a label. It is possible to only provide labels for new columns (see forest.meta examples). Otherwise the length of leftlabs and rightlabs must be the same as the number of printed columns, respectively. The value NA can be used to specify columns which should use default labels.

Author(s)

Guido Schwarzer guido.schwarzer@uniklinik-freiburg.de

Examples

data(Fleiss1993bin)
m1 <- metabin(d.asp, n.asp, d.plac, n.plac,
  data = Fleiss1993bin, studlab = study, sm = "RR", method = "I")
m1
metainf(m1)
metainf(m1, pooled = "random")

forest(metainf(m1))
forest(metainf(m1, pooled = "random"))
forest(metainf(m1, pooled = "random", prediction = TRUE))

meta documentation built on June 8, 2025, 11:45 a.m.