meta4diag (version 2.1.1)

forest: Forest plot.

Description

Takes a meta4diag object produced by the function meta4diag() and draws a forest plot.

Usage

# S3 method for meta4diag
forest(x, accuracy.type="sens", est.type="mean", p.cex="scaled", p.pch=15, p.col="black",
    nameShow="right", dataShow="center", estShow="left", text.cex=1,
    shade.col="gray", arrow.col="black", arrow.lty=1, arrow.lwd=1,
    cut=TRUE, intervals=c(0.025,0.975),
    main="Forest plot", main.cex=1.5, axis.cex=1,...)
# S3 method for meta4diag
forest.grid(x, accuracy.type = "sens", est.type = "mean", 
nameShow = T, dataShow = F, estShow = T, graphwidth = 1, main, xlab = "",...)

Arguments

x

A meta4diag object obtained by running the main function meta4diag().

accuracy.type

A string specifying the accuracy type. Options are "sens", "TPR", "spec", "TNR", "FPR", "FNR", "LRpos", "LRneg", "RD", "LLRpos", "LLRneg", "LDOR", and "DOR".

est.type

The type of estimation of study specified summary points. Options are "mean" and "median".

p.cex

Points size of study specific estimate.

p.pch

Points symbol of study specific estimate.

p.col

Points color of study specific estimate.

nameShow

Boolean indicating whether the study names are shown or not. Can also be a string indicating the alignment of the study names. Options are "left", "center" and "right".

dataShow

Boolean indicating whether the original data is shown or not. Can also be a string indicating the position to show the original data. Options are "left", "center" and "right".

estShow

Boolean indicating whether the credible intervals are shown or not. Can also be a string indicating the position to show the values of credible intervals. Options are "left", "center" and "right".

text.cex

The size to be used for the table text.

shade.col

Color of shaded area.

arrow.col

Arrow color.

arrow.lty

Arrow line style.

arrow.lwd

Arrow line width.

cut

Boolean indicating the arrows should be cut or not. Or a length 2 numerical vector indicating the cut position.

main

An overall title for the plot.

main.cex

The size to be used for main titles.

axis.cex

The size to be used for axis annotation.

intervals

A numerical vector with length 2 specifying the credible intervals that is of interst. The values should be taken from the argument quantiles (see meta4diag). The first value should be smaller than 0.5 and the second value should be larger than 0.5.

graphwidth

A numerical value indicating the main plot device size.

xlab

A title for the x axis.

...

Arguments to be passed to methods.

Value

Besides plotting, the function returns an invisible NULL.

Details

A forest plot is a graphical representation of a meta-analysis. It is usually accompanied by a table listing references (author and date) of the studies included in the meta-analysis. In the main device each line represents one study in the meta-analysis, plotted according to the estimated result. The estimated accuracy for each study is plotted as point and credible intervals as arrows. The size of the estimated accuracy for each study can be chosen to be propotional to the number of individuals in each study. A diamond indicates the overall summary point. Estimated accuracies and the correspoing credible intervals for each study are plotted. Together shown in the plot with the study names, the original dataset and the values of accuracies and the credible intervals.

The function forest() gives the user flexibility to control the plots.

Examples

# NOT RUN {
if(requireNamespace("INLA", quietly = TRUE)){
  require("INLA", quietly = TRUE)
  data(Catheter)
  res <- meta4diag(data = Catheter)
  forest(res, accuracy.type = "sens")
}
# }