gt_add_divider: Add a dividing border to an existing `gt` table.

Description

The gt_add_divider function takes an existing gt_tbl object and adds borders or dividers to specific columns.

Usage

gt_add_divider(
  gt_object,
  columns,
  sides = "right",
  color = "grey",
  style = "solid",
  weight = px(2),
  include_labels = TRUE
)

Value

An object of class gt_tbl.

Arguments

gt_object: An existing gt table object of class gt_tbl
columns: Specific columns to apply color to, accepts either tidyeval colum names or columns by position.
sides: The border sides to be modified. Options include "left", "right", "top", and "bottom". For all borders surrounding the selected cells, we can use the `"all"`` option.
color, style, weight: The border color, style, and weight. The color can be defined with a color name or with a hexadecimal color code. The default color value is "#00FFFFFF" (black). The style can be one of either "solid" (the default), "dashed", or "dotted". The weight of the border lines is to be given in pixel values (the px() helper function is useful for this. The default value for weight is "1px".
include_labels: A logical, either TRUE or FALSE indicating whether to also add dividers through the column labels.

Examples

library(gt)
basic_divider <- head(mtcars) %>%
  gt() %>%
  gt_add_divider(columns = "cyl", style = "dashed")

Figures

Function ID

2-11

Other Utilities: add_text_img(), fa_icon_repeat(), fmt_pad_num(), fmt_pct_extra(), fmt_symbol_first(), generate_df(), gt_badge(), gt_double_table(), gt_duplicate_column(), gt_fa_column(), gt_fa_rank_change(), gt_fa_rating(), gt_fa_repeats(), gt_highlight_cols(), gt_highlight_rows(), gt_img_border(), gt_img_circle(), gt_img_multi_rows(), gt_img_rows(), gt_index(), gt_merge_stack_color(), gt_merge_stack(), gt_two_column_layout(), gtsave_extra(), img_header(), pad_fn(), tab_style_by_grp()