https://github.com/cran/metafor
Tip revision: 22b3661ee3371fc7acc64b8d53f9d211ed1ee023 authored by Wolfgang Viechtbauer on 11 April 2013, 00:00:00 UTC
version 1.8-0
version 1.8-0
Tip revision: 22b3661
addpoly.Rd
\name{addpoly}
\alias{addpoly}
\title{Add Polygons to Forest Plot}
\description{
The function \code{addpoly} is generic. It can be used to add polygons to a forest plot, for example, to indicate summary estimates and fitted/predicted values.
}
\usage{
addpoly(x, \dots)
}
\arguments{
\item{x}{either an object of class \code{"rma"} or the values at which polygons should be drawn. See \sQuote{Details}.}
\item{\dots}{other arguments.}
}
\details{
Currently, methods exist for two types of situations.
In the first case, object \code{x} is a fitted model coming from the \code{\link{rma.uni}}, \code{\link{rma.mh}}, or \code{\link{rma.peto}} functions. The model must either be a fixed- or random-effects model, that is, the model should not contain any moderators. The corresponding method is called \code{\link{addpoly.rma}}. It is used to add a polygon to the bottom of an existing forest plot, showing the summary estimate with corresponding confidence interval based on the fitted model.
Alternatively, object \code{x} can be a vector with values at which one or more polygons should be drawn. The corresponding method is then \code{\link{addpoly.default}}.
}
\author{
Wolfgang Viechtbauer \email{wvb@metafor-project.org} \cr
package homepage: \url{http://www.metafor-project.org/} \cr
author homepage: \url{http://www.wvbauer.com/}
}
\references{
Viechtbauer, W. (2010). Conducting meta-analyses in R with the metafor package. \emph{Journal of Statistical Software}, \bold{36}(3), 1--48. \url{http://www.jstatsoft.org/v36/i03/}.
}
\seealso{
\code{\link{addpoly.rma}}, \code{\link{addpoly.default}}, \code{\link{forest.rma}}, \code{\link{forest.default}}
}
\keyword{methods}