tab_style_body {gt} | R Documentation |
Target cells in the table body and style accordingly
Description
With tab_style_body()
we can target cells through value, regex, and
custom matching rules and apply styles to them and their surrounding context
(i.e., styling an entire row or column wherein the match is found). Just as
with the general tab_style()
function, this function is focused on the
application of styles for HTML output only (as such, other output formats
will ignore all tab_style()
calls).
With the collection of cell_*()
helper functions available in gt, we
can modify:
the background color of the cell (
cell_fill()
:color
)the cell's text color, font, and size (
cell_text()
:color
,font
,size
)the text style (
cell_text()
:style
), enabling the use of italics or oblique text.the text weight (
cell_text()
:weight
), allowing the use of thin to bold text (the degree of choice is greater with variable fonts)the alignment and indentation of text (
cell_text()
:align
andindent
)the cell borders (
cell_borders()
)
Usage
tab_style_body(
data,
style,
columns = everything(),
rows = everything(),
values = NULL,
pattern = NULL,
fn = NULL,
targets = "cell",
extents = "body"
)
Arguments
data |
The gt table data object
This is the gt table object that is commonly created through use of the
|
style |
Style declarations
The styles to use for the targeted cells. |
columns |
Columns to target
The columns to which substitution operations are constrained. Can either
be a series of column names provided in |
rows |
Rows to target
In conjunction with |
values |
Values for targeting
The specific value or values that should be targeted for styling. If
|
pattern |
Regex pattern for targeting
A regex pattern that can target solely those values in |
fn |
Function to return logical values
A supplied function that operates on each cell of each column specified
through |
targets |
Styling targets
A vector of styling target keywords to contain or expand the target of each
cell. By default, this is a vector just containing |
extents |
Styling extents
A vector of locations to project styling. By default, this is a vector just
containing |
Value
An object of class gt_tbl
.
Examples
Use exibble
to create a gt table with a stub and row groups. This
contains an assortment of values that could potentially undergo some styling
via tab_style_body()
.
gt_tbl <- exibble |> gt( rowname_col = "row", groupname_col = "group" )
Cells in the table body can be styled through specification of literal values
in the values
argument of tab_style_body()
. It's okay to search for
numerical, character, or logical values across all columns. Let's target the
values 49.95
and 33.33
and style those cells with an orange fill.
gt_tbl |> tab_style_body( style = cell_fill(color = "orange"), values = c(49.95, 33.33) )

Multiple styles can be combined in a list
, here's an example of that using
the same cell targets:
gt_tbl |> tab_style_body( style = list( cell_text(font = google_font("Inter"), color = "white"), cell_fill(color = "red"), cell_borders( sides = c("left", "right"), color = "steelblue", weight = px(4) ) ), values = c(49.95, 33.33) )

You can opt to color entire rows or columns (or both, should you want to)
with those specific keywords in the targets
argument. For the 49.95
value
we will style the entire row and with 33.33
the entire column will get the
same styling.
gt_tbl |> tab_style_body( style = cell_fill(color = "lightblue"), values = 49.95, targets = "row" ) |> tab_style_body( style = cell_fill(color = "lightblue"), values = 33.33, targets = "column" )

In a minor variation to the prior example, it's possible to extend the
styling to other locations, or, entirely project the styling elsewhere. This
is done with the extents
argument. Valid keywords that can be included in
the vector are: "body"
(the default) and "stub"
. Let's take the previous
example and extend the styling of the row into the stub.
gt_tbl |> tab_style_body( style = cell_fill(color = "lightblue"), values = 49.95, targets = "row", extents = c("body", "stub") ) |> tab_style_body( style = cell_fill(color = "lightblue"), values = 33.33, targets = "column" )

We can also use the pattern
argument to target cell values in
character
-based columns. The "fctr"
column is skipped because it is in
fact a factor-based column.
gt_tbl |> tab_style_body( style = cell_fill(color = "green"), pattern = "ne|na" )

For the most flexibility in targeting, it's best to use the fn
argument.
The function you give to fn
will be invoked separately on all cells so the
columns
argument of tab_style_body()
might be useful to limit which cells
should be evaluated. For this next example, the supplied function should only
be used on numeric values and we can make sure of this by using columns = where(is.numeric)
.
gt_tbl |> tab_style_body( columns = where(is.numeric), style = cell_fill(color = "pink"), fn = function(x) x >= 0 && x < 50 )

Styling every NA
value in a table is also easily accomplished with the fn
argument by way of is.na()
.
gt_tbl |> tab_style_body( style = cell_text(color = "red3"), fn = function(x) is.na(x) ) |> sub_missing(missing_text = "Not Available")

Function ID
2-11
Function Introduced
v0.8.0
(November 16, 2022)
See Also
Other part creation/modification functions:
tab_caption()
,
tab_footnote()
,
tab_header()
,
tab_info()
,
tab_options()
,
tab_row_group()
,
tab_source_note()
,
tab_spanner()
,
tab_spanner_delim()
,
tab_stub_indent()
,
tab_stubhead()
,
tab_style()