With numeric values in a gt table, we can perform number-based formatting so that the targeted values are always rendered as integer values. We can have fine control over integer formatting with the following options:
digit grouping separators: options to enable/disable digit separators and provide a choice of separator symbol
scaling: we can choose to scale targeted values by a multiplier value
large-number suffixing: larger figures (thousands, millions, etc.) can be autoscaled and decorated with the appropriate suffixes
pattern: option to use a text pattern for decoration of the formatted values
locale-based formatting: providing a locale ID will result in number formatting specific to the chosen locale
Usage
fmt_integer(
data,
columns,
rows = everything(),
use_seps = TRUE,
accounting = FALSE,
scale_by = 1,
suffixing = FALSE,
pattern = "{x}",
sep_mark = ",",
force_sign = FALSE,
system = c("intl", "ind"),
locale = NULL
)
Arguments
- data
A table object that is created using the
gt()
function.- columns
The columns to format. Can either be a series of column names provided in
c()
, a vector of column indices, or a helper function focused on selections. The select helper functions are:starts_with()
,ends_with()
,contains()
,matches()
,one_of()
,num_range()
, andeverything()
.- rows
Optional rows to format. Providing
everything()
(the default) results in all rows incolumns
being formatted. Alternatively, we can supply a vector of row captions withinc()
, a vector of row indices, or a helper function focused on selections. The select helper functions are:starts_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
).- use_seps
An option to use digit group separators. The type of digit group separator is set by
sep_mark
and overridden if a locale ID is provided tolocale
. This setting isTRUE
by default.- accounting
An option to use accounting style for values. With
FALSE
(the default), negative values will be shown with a minus sign. Usingaccounting = TRUE
will put negative values in parentheses.- scale_by
A value to scale the input. The default is
1.0
. All numeric values will be multiplied by this value first before undergoing formatting. This value will be ignored if using any of thesuffixing
options (i.e., wheresuffixing
is not set toFALSE
).- suffixing
An option to scale and apply suffixes to larger numbers (e.g.,
1924000
can be transformed to2M
). This option can accept a logical value, whereFALSE
(the default) will not perform this transformation andTRUE
will apply thousands (K
), millions (M
), billions (B
), and trillions (T
) suffixes after automatic value scaling. We can also specify which symbols to use for each of the value ranges by using a character vector of the preferred symbols to replace the defaults (e.g.,c("k", "Ml", "Bn", "Tr")
).Including
NA
values in the vector will ensure that the particular range will either not be included in the transformation (e.g,c(NA, "M", "B", "T")
won't modify numbers in the thousands range) or the range will inherit a previous suffix (e.g., withc("K", "M", NA, "T")
, all numbers in the range of millions and billions will be in terms of millions).Any use of
suffixing
(where it is not set expressly asFALSE
) means that any value provided toscale_by
will be ignored.- pattern
A formatting pattern that allows for decoration of the formatted value. The value itself is represented by
{x}
and all other characters are taken to be string literals.- sep_mark
The mark to use as a separator between groups of digits (e.g., using
sep_mark = ","
with1000
would result in a formatted value of1,000
).- force_sign
Should the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use
TRUE
for this option. The default isFALSE
, where only negative numbers will display a minus sign. This option is disregarded when using accounting notation withaccounting = TRUE
.- system
The numbering system to use. By default, this is the international numbering system (
"intl"
) whereby grouping separators (i.e.,sep_mark
) are separated by three digits. The alternative system, the Indian numbering system ("ind"
) uses grouping separators that correspond to thousand, lakh, crore, and higher quantities.- locale
An optional locale ID that can be used for formatting the value according the locale's rules. Examples include
"en"
for English (United States) and"fr"
for French (France). The use of a valid locale ID will override any values provided insep_mark
anddec_mark
. We can use theinfo_locales()
function as a useful reference for all of the locales that are supported. Anylocale
value provided here will override any global locale setting performed ingt()
's ownlocale
argument.
Targeting the values to be formatted
Targeting of values is done through columns
and additionally by rows
(if
nothing is provided for rows
then entire columns are selected). Conditional
formatting is possible by providing a conditional expression to the rows
argument. See the Arguments section for more information on this.
Examples
Use exibble
to create a gt table. format the num
column as integer
values having no digit separators (with the use_seps = FALSE
option).
See also
Other data formatting functions:
data_color()
,
fmt_bytes()
,
fmt_currency()
,
fmt_datetime()
,
fmt_date()
,
fmt_duration()
,
fmt_engineering()
,
fmt_fraction()
,
fmt_markdown()
,
fmt_number()
,
fmt_partsper()
,
fmt_passthrough()
,
fmt_percent()
,
fmt_roman()
,
fmt_scientific()
,
fmt_time()
,
fmt()
,
sub_large_vals()
,
sub_missing()
,
sub_small_vals()
,
sub_values()
,
sub_zero()
,
text_transform()