add_text: Add text to forest plot

In forestploter: Create a Flexible Forest Plot

Add text to forest plot

Description

This function can be used to add text to forest plot. The text can be span to multiple rows and columns. The height of the row will be changed accordingly if the text is added to only one row. The width of the text may exceeds the columns provided if the text is too long.

Usage

add_text(
  plot,
  text,
  row = NULL,
  col = NULL,
  part = c("body", "header"),
  just = c("center", "left", "right"),
  gp = gpar(),
  padding = unit(1, "mm"),
  parse = FALSE
)

Arguments

plot	A forest plot object.
text	A character or expression vector, see textGrob.
row	Row to add the text, this will be ignored if the part is "header".
col	A numeric value or vector indicating the columns the text will be added. The text will span over the column if a vector is given.
part	Part to add text, body (default) or header.
just	The justification of the text, "center" (default), "left" or "right".
gp	An object of class "gpar", this is the graphical parameter settings of the text. See gpar.
padding	Padding of the text, default is unit(1, "mm")
parse	Logical, behaviour for parsing text as plotmath, see plotmath

Value

A gtable object.

See Also

gtable gpar textGrob gtable_add_grob

forestploter documentation built on May 29, 2024, 5:48 a.m.