Usage
## S3 method for class 'cumul.rma':
forest(x, annotate=TRUE, xlim, alim, ylim, at, steps=5,
level=x$level, digits=2, refline=0, xlab,
ilab, ilab.xpos, ilab.pos,
transf=FALSE, atransf=FALSE, targs, rows,
efac=1, pch=15, psize=1,
cex, cex.lab, cex.axis, \dots)Arguments
x
an object of class "cumul.rma".
annotate
logical specifying whether annotations should be added to the plot (default is TRUE).
xlim
horizontal limits of the plot region. If unspecified, the function tries to set the horizontal plot limits to some sensible values.
alim
the actual x-axis limits. If unspecified, the function tries to set the x-axis limits to some sensible values.
ylim
the y limits of the plot. If unspecified, the function tries to set the y-axis limits to some sensible values.
at
position of the x-axis tick marks and corresponding labels. If unspecified, the function tries to set the tick mark positions/labels to some sensible values.
steps
the number of tick marks for the x-axis (default is 5). Ignored when the user specifies the positions via the at argument.
level
numerical value between 0 and 100 specifying the confidence interval level (the default is to take the value from the object).
digits
integer specifying the number of decimal places to which the tick mark labels of the x-axis and the annotations should be rounded (default is 2). Can also be a vector of two integers, the first specifying the number of decimal places for the annotations,
refline
value at which a vertical reference line should be drawn (default is 0). The line can be suppressed by setting this argument to NA.
xlab
title for the x-axis. If unspecified, the function tries to set an appropriate axis title.
ilab
optional vector or matrix of character strings providing additional information about the studies.
ilab.xpos
vector of numerical value(s) specifying the x-axis position(s) of the character vector(s) given via ilab (must be specified if ilab is specified).
ilab.pos
integer(s) (either 1, 2, 3, or 4) specifying the alignment of the character vector(s) given via ilab (2 means right, 4 means left aligned). If unspecified, the default is to center the labels.
transf
optional argument specifying the name of a function that should be used to transform the observed effect sizes, summary estimates, fitted values, and confidence interval bounds (e.g., transf=exp). Defaults to FALSE, which means t
atransf
optional argument specifying the name of a function that should be used to transform the x-axis labels and annotations (e.g., transf=exp). Defaults to FALSE, which means that no transformation is used.
targs
optional arguments needed by the function specified via transf or atransf.
rows
optional vector specifying the rows (or more generally, the horizontal positions) for plotting the outcomes. If unspecified, the function sets this value automatically. Can also be a single value specifying the row (horizontal position) of the first outco
efac
vertical expansion factor for arrows, confidence interval limits, and the symbol used to denote summary estimates. The default value of 1 should usually work okay.
pch
plotting symbol to use for the observed effect sizes or outcomes. By default, a filled square is used. See points for other options. Can also be a vector of values. psize
optional vector with point sizes for the observed effect sizes or outcomes. Default is 1.
cex
optional character and symbol expansion factor. If unspecified, the function tries to set this to a sensible value.
cex.lab
optional expansion factor for the x-axis titel. If unspecified, the function tries to set this to a sensible value.
cex.axis
optional expansion factor for the x-axis labels. If unspecified, the function tries to set this to a sensible value.