prGetShapeGp: A function to extract graphical parameters from a fpShapesGp...

In forestplot: Advanced Forest Plot Using 'grid' Graphics

A function to extract graphical parameters from a fpShapesGp object

Description

A function to extract graphical parameters from a fpShapesGp object

Usage

prGetShapeGp(
  shapes_gp,
  coords,
  object,
  default = grid::gpar(),
  nodefault = FALSE
)

Arguments

shapes_gp	An object of class fpShapesGp specifying all graphical parameters
coords	A numeric vector of length 2, specifying the label number (first item of the vector) and the confidence band number within this label ; that can be >= 2 if there are multiple confidence bands per label. Can be NULL for objects that are used only once (e.g. axes). Vector coords must have an R attribute max.coords as numeric vector of length 2 specifying the total number of labels and number of confidence bands by label for the forest plot. The first coordinate specify the label number and the second coordinate (for multi-band forest plots) specifies the band number within the label.
object	One of "box", "lines", "vertices", "summary", "zero", "axes", "hrz_lines" or "grid", refering to the object for which the graphical parameters are requested.
default	Default attributes to rely on when neither found in shapes_gp$object nor in shapes_gp$default
nodefault	Logical. If TRUE, do not search attribute in shapes_gp$default

Value

An object of class gpar

Author(s)

Andre GILLIBERT

forestplot documentation built on Oct. 11, 2024, 5:07 p.m.