With numeric values in a gt table we can transform those to numbers that
are spelled out with the fmt_spelled_num()
function. Any values from 0
to
100
can be spelled out so, for example, the value 23
will be formatted as
"twenty-three"
. Providing a locale ID will result in the number spelled out
in the locale's language rules. For example, should a Swedish locale ("sv"
)
be provided, the input value 23
will yield "tjugotre"
. In addition to
this, we can optionally use the pattern
argument for decoration of the
formatted values.
Usage
fmt_spelled_num(
data,
columns = everything(),
rows = everything(),
pattern = "{x}",
locale = NULL
)
Arguments
- data
The gt table data object
obj:<gt_tbl>
--- requiredThis is the gt table object that is commonly created through use of the
gt()
function.- columns
Columns to target
<column-targeting expression>
--- default:everything()
Can either be a series of column names provided in
c()
, a vector of column indices, or a select helper function. Examples of select helper functions includestarts_with()
,ends_with()
,contains()
,matches()
,one_of()
,num_range()
, andeverything()
.- rows
Rows to target
<row-targeting expression>
--- default:everything()
In conjunction with
columns
, we can specify which of their rows should undergo formatting. The defaulteverything()
results in all rows incolumns
being formatted. Alternatively, we can supply a vector of row captions withinc()
, a vector of row indices, or a select helper function. Examples of select helper functions includestarts_with()
,ends_with()
,contains()
,matches()
,one_of()
,num_range()
, andeverything()
. We can also use expressions to filter down to the rows we need (e.g.,[colname_1] > 100 & [colname_2] < 50
).- pattern
Specification of the formatting pattern
scalar<character>
--- default:"{x}"
A formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the
{x}
(which can be used multiple times, if needed) and all other characters will be interpreted as string literals.- locale
Locale identifier
scalar<character>
--- default:NULL
(optional
)An optional locale identifier that can be used for formatting values according the locale's rules. Examples include
"en"
for English (United States) and"fr"
for French (France). We can use theinfo_locales()
function as a useful reference for all of the locales that are supported. A locale ID can be also set in the initialgt()
function call (where it would be used automatically by any function with alocale
argument) but alocale
value provided here will override that global locale.
Compatibility of formatting function with data values
The fmt_spelled_num()
formatting function is compatible with body cells
that are of the "numeric"
or "integer"
types. Any other types of body
cells are ignored during formatting. This is to say that cells of
incompatible data types may be targeted, but there will be no attempt to
format them.
Targeting cells with columns
and rows
Targeting of values is done through columns
and additionally by rows
(if
nothing is provided for rows
then entire columns are selected). The
columns
argument allows us to target a subset of cells contained in the
resolved columns. We say resolved because aside from declaring column names
in c()
(with bare column names or names in quotes) we can use
tidyselect-style expressions. This can be as basic as supplying a select
helper like starts_with()
, or, providing a more complex incantation like
where(~ is.numeric(.x) && max(.x, na.rm = TRUE) > 1E6)
which targets numeric columns that have a maximum value greater than
1,000,000 (excluding any NA
s from consideration).
By default all columns and rows are selected (with the everything()
defaults). Cell values that are incompatible with a given formatting function
will be skipped over, like character
values and numeric fmt_*()
functions. So it's safe to select all columns with a particular formatting
function (only those values that can be formatted will be formatted), but,
you may not want that. One strategy is to format the bulk of cell values with
one formatting function and then constrain the columns for later passes with
other types of formatting (the last formatting done to a cell is what you get
in the final output).
Once the columns are targeted, we may also target the rows
within those
columns. This can be done in a variety of ways. If a stub is present, then we
potentially have row identifiers. Those can be used much like column names in
the columns
-targeting scenario. We can use simpler tidyselect-style
expressions (the select helpers should work well here) and we can use quoted
row identifiers in c()
. It's also possible to use row indices (e.g.,
c(3, 5, 6)
) though these index values must correspond to the row numbers of
the input data (the indices won't necessarily match those of rearranged rows
if row groups are present). One more type of expression is possible, an
expression that takes column values (can involve any of the available columns
in the table) and returns a logical vector. This is nice if you want to base
formatting on values in the column or another column, or, you'd like to use a
more complex predicate expression.
Supported locales
The following 80 locales are supported in the locale
argument of
fmt_spelled_num()
: "af"
(Afrikaans), "ak"
(Akan), "am"
(Amharic),
"ar"
(Arabic), "az"
(Azerbaijani), "be"
(Belarusian), "bg"
(Bulgarian), "bs"
(Bosnian), "ca"
(Catalan), "ccp"
(Chakma), "chr"
(Cherokee), "cs"
(Czech), "cy"
(Welsh), "da"
(Danish), "de"
(German),
"de-CH"
(German (Switzerland)), "ee"
(Ewe), "el"
(Greek), "en"
(English), "eo"
(Esperanto), "es"
(Spanish), "et"
(Estonian), "fa"
(Persian), "ff"
(Fulah), "fi"
(Finnish), "fil"
(Filipino), "fo"
(Faroese), "fr"
(French), "fr-BE"
(French (Belgium)), "fr-CH"
(French
(Switzerland)), "ga"
(Irish), "he"
(Hebrew), "hi"
(Hindi), "hr"
(Croatian), "hu"
(Hungarian), "hy"
(Armenian), "id"
(Indonesian),
"is"
(Icelandic), "it"
(Italian), "ja"
(Japanese), "ka"
(Georgian),
"kk"
(Kazakh), "kl"
(Kalaallisut), "km"
(Khmer), "ko"
(Korean),
"ky"
(Kyrgyz), "lb"
(Luxembourgish), "lo"
(Lao), "lrc"
(Northern
Luri), "lt"
(Lithuanian), "lv"
(Latvian), "mk"
(Macedonian), "ms"
(Malay), "mt"
(Maltese), "my"
(Burmese), "ne"
(Nepali), "nl"
(Dutch),
"nn"
(Norwegian Nynorsk), "no"
(Norwegian), "pl"
(Polish), "pt"
(Portuguese), "qu"
(Quechua), "ro"
(Romanian), "ru"
(Russian), "se"
(Northern Sami), "sk"
(Slovak), "sl"
(Slovenian), "sq"
(Albanian),
"sr"
(Serbian), "sr-Latn"
(Serbian (Latin)), "su"
(Sundanese), "sv"
(Swedish), "sw"
(Swahili), "ta"
(Tamil), "th"
(Thai), "tr"
(Turkish),
"uk"
(Ukrainian), "vi"
(Vietnamese), "yue"
(Cantonese), and "zh"
(Chinese).
Examples
Let's use a summarized version of the gtcars
dataset to create a
gt table. The fmt_spelled_num()
function is used to transform
integer values into spelled-out numbering (in the n
column). That formatted
column of numbers-as-words is given cell background colors via data_color()
(the underlying numerical values are always available).
gtcars |>
dplyr::select(mfr, ctry_origin) |>
dplyr::group_by(mfr, ctry_origin) |>
dplyr::count() |>
dplyr::ungroup() |>
dplyr::arrange(ctry_origin) |>
gt(rowname_col = "mfr", groupname_col = "ctry_origin") |>
cols_label(n = "No. of Entries") |>
fmt_spelled_num() |>
tab_stub_indent(rows = everything(), indent = 2) |>
data_color(
columns = n,
method = "numeric",
palette = "viridis",
alpha = 0.8
) |>
opt_all_caps() |>
opt_vertical_padding(scale = 0.5) |>
cols_align(align = "center", columns = n)
With a considerable amount of dplyr and tidyr work done to the
pizzaplace
dataset, we can create a new gt table. The
fmt_spelled_num()
function will be used here to transform the integer
values in the rank
column. We'll do so with a special pattern
that puts
the word 'Number' in front of every spelled-out number.
pizzaplace |>
dplyr::mutate(month = lubridate::month(date, label = TRUE)) |>
dplyr::filter(month %in% month.abb[1:6]) |>
dplyr::group_by(name, month) |>
dplyr::summarize(sum = sum(price), .groups = "drop") |>
dplyr::arrange(month, desc(sum)) |>
dplyr::group_by(month) |>
dplyr::slice_head(n = 5) |>
dplyr::mutate(rank = dplyr::row_number()) |>
dplyr::ungroup() |>
dplyr::select(-sum) |>
tidyr::pivot_wider(names_from = month, values_from = c(name)) |>
gt() |>
fmt_spelled_num(columns = rank, pattern = "Number {x}") |>
opt_all_caps() |>
cols_align(columns = -rank, align = "center") |>
cols_width(
rank ~ px(120),
everything() ~ px(100)
) |>
opt_table_font(stack = "rounded-sans") |>
tab_options(table.font.size = px(14))
See also
The vector-formatting version of this function:
vec_fmt_spelled_num()
.
Other data formatting functions:
data_color()
,
fmt_auto()
,
fmt_bins()
,
fmt_bytes()
,
fmt_currency()
,
fmt_datetime()
,
fmt_date()
,
fmt_duration()
,
fmt_engineering()
,
fmt_flag()
,
fmt_fraction()
,
fmt_image()
,
fmt_index()
,
fmt_integer()
,
fmt_markdown()
,
fmt_number()
,
fmt_partsper()
,
fmt_passthrough()
,
fmt_percent()
,
fmt_roman()
,
fmt_scientific()
,
fmt_time()
,
fmt_url()
,
fmt()
,
sub_large_vals()
,
sub_missing()
,
sub_small_vals()
,
sub_values()
,
sub_zero()