add_border: Add border to cells

View source: R/add_border.R

add_borderR Documentation

Add border to cells

Description

Add border to any cells at any side.

add_underline is a wrapper of add_border can be used to add underline to cells.

Usage

add_border(
  plot,
  row = NULL,
  col = NULL,
  part = c("body", "header"),
  where = c("bottom", "left", "top", "right"),
  gp = gpar(lwd = 2)
)

add_underline(
  plot,
  row = NULL,
  col = NULL,
  part = c("body", "header"),
  gp = gpar(lwd = 2)
)

Arguments

plot

A forest plot object.

row

A numeric value or vector indicating row number to add border. This is corresponding to the data row number. Remember to account for any text inserted. A border will be drawn to all rows if this is omitted.

col

A numeric value or vector indicating the columns to add border. A border will be drawn to all columns if this is omitted.

part

The border will be added to "body" (default) or "header".

where

Where to draw the border of the cell, possible values are "bottom" (default), "left", "top" and "right"

gp

An object of class "gpar", graphical parameter to be passed to segmentsGrob.

Value

A gtable object.

See Also

gpar segmentsGrob gtable_add_grob


forestploter documentation built on Sept. 24, 2023, 1:07 a.m.