Learn R Programming
forestplot (version 1.0)

fpLegend: A function for the legend used in forestplot()

Description

This function encapsulates all the legend options that are used in the forestplot function. This is in order to limit the crowding among the arguments for the forestplot call.

Usage

fpLegend(pos = "top", gp = NULL, r = unit(0, "snpc"),
  padding = unit(ifelse(!is.null(gp), 3, 0), "mm"), title = NULL)

Arguments

pos
The position of the legend, either at the "top" or the "right" unlesss positioned inside the plot. If you want the legend to be positioned inside the plot then you have to provide a list with the same x & y qualities as
gp
The gpar options for the legend. If you want the background color to be light grey then use gp = gpar(fill = "lightgrey"). If you want a border then set the col argument: gp =
r
The box can have rounded edges, check out grid.roundrect. The r option should be a unit object. This is by default unit(0, "snpc")
padding
The padding for the legend box, only used if box is drawn. This is the distance from the border to the text/boxes of the legend.
title
The title of the legend if any

Value

  • list Returns a list with all the elements

See Also

Other forestplot.functions: forestplot; fpColors; fpDrawCircleCI, fpDrawDiamondCI, fpDrawNormalCI, fpDrawPointCI, fpDrawSummaryCI