opt_table_outline: Option to wrap an outline around the entire table

In gt: Easily Create Presentation-Ready Display Tables

Option to wrap an outline around the entire table

Description

This function puts an outline of consistent style, width, and color around the entire table. It'll write over any existing outside lines so long as the width is larger that of the existing lines. The default value of style ("solid") will draw a solid outline, whereas a value of "none" will remove any present outline.

Usage

opt_table_outline(data, style = "solid", width = px(3), color = "#D3D3D3")

Arguments

data	The gt table data object ⁠obj:<gt_tbl>⁠ // required This is the gt table object that is commonly created through use of the gt() function.
style	Outline style property ⁠scalar<character>⁠ // default: "solid" The style property for the table outline. By default, this is "solid". If "none" is used then the outline is removed and any values provided for width and color will be ignored (i.e., not set).
width	Outline width value ⁠scalar<character>⁠ // default: px(3) The width property for the table outline. By default, this is px(3) (or, "3px").
color	Color of outline ⁠scalar<character>⁠ // default: "#D3D3D3" The color of the table outline. By default, this is "#D3D3D3".

Value

An object of class gt_tbl.

Examples

Use the exibble dataset to create a gt table with a number of table parts added (using functions like summary_rows(), grand_summary_rows(), and more). Following that, let's make it so that we have an outline wrap around the entire table by using the opt_table_outline() function.

tab_1 <-
  exibble |>
  gt(rowname_col = "row", groupname_col = "group") |>
  summary_rows(
    groups = "grp_a",
    columns = c(num, currency),
    fns = c("min", "max")
  ) |>
  grand_summary_rows(
    columns = currency,
    fns = total ~ sum(., na.rm = TRUE)
  ) |>
  tab_source_note(source_note = "This is a source note.") |>
  tab_footnote(
    footnote = "This is a footnote.",
    locations = cells_body(columns = 1, rows = 1)
  ) |>
  tab_header(
    title = "The title of the table",
    subtitle = "The table's subtitle"
  ) |>
  opt_table_outline()

tab_1

Remove the table outline with the style = "none" option.

tab_1 |> opt_table_outline(style = "none")

Function ID

10-11

Function Introduced

v0.2.0.5 (March 31, 2020)

See Also

Other table option functions: opt_align_table_header(), opt_all_caps(), opt_css(), opt_footnote_marks(), opt_footnote_spec(), opt_horizontal_padding(), opt_interactive(), opt_row_striping(), opt_stylize(), opt_table_font(), opt_table_lines(), opt_vertical_padding()

gt documentation built on Sept. 11, 2024, 5:15 p.m.