With numeric values in a gt table we can format the values so that they
are rendered as per mille, ppm, ppb, etc., quantities. The following
list of keywords (with associated naming and scaling factors) is available to
use within fmt_partsper()
:
"per-mille"
: Per mille, (1 part in 1,000
)
"per-myriad"
: Per myriad, (1 part in 10,000
)
"pcm"
: Per cent mille (1 part in 100,000
)
"ppm"
: Parts per million, (1 part in 1,000,000
)
"ppb"
: Parts per billion, (1 part in 1,000,000,000
)
"ppt"
: Parts per trillion, (1 part in 1,000,000,000,000
)
"ppq"
: Parts per quadrillion, (1 part in 1,000,000,000,000,000
)
The function provides a lot of formatting control and we can use the following options:
custom symbol/units: we can override the automatic symbol or units display with our own choice as the situation warrants
decimals: choice of the number of decimal places, option to drop trailing zeros, and a choice of the decimal symbol
digit grouping separators: options to enable/disable digit separators and provide a choice of separator symbol
value scaling toggle: choose to disable automatic value scaling in the situation that values are already scaled coming in (and just require the appropriate symbol or unit display)
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
fmt_partsper(
data,
columns,
rows = everything(),
to_units = c("per-mille", "per-myriad", "pcm", "ppm", "ppb", "ppt", "ppq"),
symbol = "auto",
decimals = 2,
drop_trailing_zeros = FALSE,
drop_trailing_dec_mark = TRUE,
scale_values = TRUE,
use_seps = TRUE,
pattern = "{x}",
sep_mark = ",",
dec_mark = ".",
force_sign = FALSE,
incl_space = "auto",
system = c("intl", "ind"),
locale = NULL
)
An object of class gt_tbl
.
A table object that is created using the gt()
function.
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()
, and
everything()
.
Optional rows to format. Providing everything()
(the
default) results in all rows in columns
being formatted. Alternatively,
we can supply a vector of row captions within c()
, 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()
, and everything()
. We can also use expressions
to filter down to the rows we need (e.g.,
[colname_1] > 100 & [colname_2] < 50
).
A keyword that signifies the desired output quantity. This
can be any from the following set: "per-mille"
, "per-myriad"
, "pcm"
,
"ppm"
, "ppb"
, "ppt"
, or "ppq"
.
The symbol/units to use for the quantity. By default, this is
set to "auto"
and gt will choose the appropriate symbol based on the
to_units
keyword and the output context. However, this can be changed by
supplying a string (e.g, using symbol = "ppbV"
when to_units = "ppb"
).
An option to specify the exact number of decimal places to
use. The default number of decimal places is 2
.
A logical value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).
A logical value that determines whether decimal
marks should always appear even if there are no decimal digits to display
after formatting (e.g, 23
becomes 23.
). The default for this is TRUE
,
which means that trailing decimal marks are not shown.
Should the values be scaled through multiplication
according to the keyword set in to_units
? By default this is TRUE
since
the expectation is that normally values are proportions. Setting to FALSE
signifies that the values are already scaled and require only the
appropriate symbol/units when formatted.
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 to locale
. This setting is TRUE
by default.
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.
The mark to use as a separator between groups of digits
(e.g., using sep_mark = ","
with 1000
would result in a formatted value
of 1,000
).
The character to use as a decimal mark (e.g., using dec_mark = ","
with 0.152
would result in a formatted value of 0,152
).
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 is FALSE
, where only negative numbers will
display a minus sign. This option is disregarded when using accounting
notation with accounting = TRUE
.
An option for whether to include a space between the value
and the symbol/units. The default is "auto"
which provides spacing
dependent on the mark itself. This can be directly controlled by using
either TRUE
or FALSE
.
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.
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 in sep_mark
and dec_mark
. We can use the
info_locales()
function as a useful reference for all of the locales that
are supported. Any locale
value provided here will override any global
locale setting performed in gt()
's own locale
argument.
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.
Create a tibble of small numeric values and generate a gt table. Format
the a
column to appear in scientific notation with fmt_scientific()
and
format the b
column as per mille values with fmt_partsper()
.
dplyr::tibble(x = 0:-5, a = 10^(0:-5), b = a) %>%
gt(rowname_col = "x") %>%
fmt_scientific(a, decimals = 0) %>%
fmt_partsper(
columns = b,
to_units = "per-mille"
)
3-6
Other data formatting functions:
data_color()
,
fmt_bytes()
,
fmt_currency()
,
fmt_datetime()
,
fmt_date()
,
fmt_duration()
,
fmt_engineering()
,
fmt_fraction()
,
fmt_integer()
,
fmt_markdown()
,
fmt_number()
,
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()