fmt_passthrough {gt} | R Documentation |
Format by simply passing data through
Description
We can format values with fmt_passthrough()
, which does little
more than: (1) coercing to character
(as all the fmt_*()
functions do),
and (2) applying decorator text via the pattern
argument (the default is to
apply nothing). This formatting function is useful when don't want to modify
the input data other than to decorate it within a pattern.
Usage
fmt_passthrough(
data,
columns = everything(),
rows = everything(),
escape = TRUE,
pattern = "{x}"
)
Arguments
data |
The gt table data object
This is the gt table object that is commonly created through use of the
|
columns |
Columns to target
Can either be a series of column names provided in |
rows |
Rows to target
In conjunction with |
escape |
Text escaping
An option to escape text according to the final output format of the table.
For example, if a LaTeX table is to be generated then LaTeX escaping would
be performed during rendering. By default this is set to |
pattern |
Specification of the formatting pattern
A formatting pattern that allows for decoration of the formatted value. The
formatted value is represented by the |
Value
An object of class gt_tbl
.
Compatibility of arguments with the from_column()
helper function
from_column()
can be used with certain arguments of fmt_passthrough()
to
obtain varying parameter values from a specified column within the table.
This means that each row could be formatted a little bit differently. These
arguments provide support for from_column()
:
-
escape
-
pattern
Please note that for both of the aforementioned arguments, a from_column()
call needs to reference a column that has data of the correct type (this is
different for each argument). Additional columns for parameter values can be
generated with cols_add()
(if not already present). Columns that contain
parameter data can also be hidden from final display with cols_hide()
.
Finally, there is no limitation to how many arguments the from_column()
helper is applied so long as the arguments belong to this closed set.
Examples
Let's use the exibble
dataset to create a single-column gt table
(with only the char
column). Now we can pass the data in that column
through the 'non-formatter' that is fmt_passthrough()
. While the the
function doesn't do any explicit formatting it has a feature common to all
other formatting functions: the pattern
argument. So that's what we'll use
in this example, applying a simple pattern to the non-NA
values that adds
an "s"
character.
exibble |> dplyr::select(char) |> gt() |> fmt_passthrough( rows = !is.na(char), pattern = "{x}s" )

Function ID
3-28
Function Introduced
v0.2.0.5
(March 31, 2020)
See Also
Other data formatting functions:
data_color()
,
fmt()
,
fmt_auto()
,
fmt_bins()
,
fmt_bytes()
,
fmt_chem()
,
fmt_country()
,
fmt_currency()
,
fmt_date()
,
fmt_datetime()
,
fmt_duration()
,
fmt_email()
,
fmt_engineering()
,
fmt_flag()
,
fmt_fraction()
,
fmt_icon()
,
fmt_image()
,
fmt_index()
,
fmt_integer()
,
fmt_markdown()
,
fmt_number()
,
fmt_partsper()
,
fmt_percent()
,
fmt_roman()
,
fmt_scientific()
,
fmt_spelled_num()
,
fmt_tf()
,
fmt_time()
,
fmt_units()
,
fmt_url()
,
sub_large_vals()
,
sub_missing()
,
sub_small_vals()
,
sub_values()
,
sub_zero()