Bold rows in a gt table — gt_bold

Bolds the body cells of chosen rows, with an option to recolor their text and fill their background. Rows are chosen by index or by a filter expression; with neither, every row is bolded.

Usage

gt_bold_rows(
  gt_object,
  rows = NULL,
  text_color = "black",
  highlight_color = NULL,
  row = NULL,
  filter_statement = NULL
)

Arguments

gt_object: A gt table object to modify.
rows: The rows to bold. Either an expression evaluated against the table's data, such as mpg > 20, or a numeric vector of row indices. If NULL, every row is bolded. Defaults to NULL.
text_color: Character. The text color for the bolded rows. Defaults to "black".
highlight_color: Character. The background fill for the bolded rows. Set to NULL for no fill. Defaults to NULL.
row: Deprecated. Use rows.
filter_statement: Deprecated. Use rows, which takes the expression directly rather than as a string.

Value

Returns a modified gt table with the chosen rows bolded.

Details

When filter_statement is supplied it is parsed and evaluated against the table's underlying data, and the rows it matches are bolded. A row vector takes over when no filter is given. The styling is applied with a single gt::tab_style() over gt::cells_body(), so it covers every column of the chosen rows.

Examples

if (FALSE) { # \dontrun{
library(gt)

# bold every row
gt(head(mtcars)) %>% gt_bold_rows()

# bold and fill the rows above 20 mpg
gt(head(mtcars)) %>%
  gt_bold_rows(filter_statement = "mpg > 20", highlight_color = "#FFF3B0")
} # }