fmt_percent: Format values as a percentage
Description
With numeric values in a gt table, we can perform percentage-based
formatting. It is assumed the input numeric values are proportional values
and, in this case, the values will be automatically multiplied by 100
before decorating with a percent sign (the other case is accommodated though
setting the scale_values to FALSE). For more control over percentage
formatting, we can use the following options:
percent sign placement: the percent sign can be placed after or before the values and a space can be inserted between the symbol and the value.
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
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_percent(
data,
columns,
rows = everything(),
decimals = 2,
drop_trailing_zeros = FALSE,
drop_trailing_dec_mark = TRUE,
scale_values = TRUE,
use_seps = TRUE,
accounting = FALSE,
pattern = "{x}",
sep_mark = ",",
dec_mark = ".",
force_sign = FALSE,
incl_space = FALSE,
placement = "right",
system = c("intl", "ind"),
locale = NULL
)Arguments
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).
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 by
100? 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 percent sign 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.
An option to use accounting style for values. With FALSE
(the default), negative values will be shown with a minus sign. Using
accounting = TRUE will put negative values in parentheses.
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 percent sign. The default is to not introduce a space character.
The placement of the percent sign. This can be either be
right (the default) or left.
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_US" for English
(United States) and "fr_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.
Value
An object of class gt_tbl.
Figures
Function ID
3-5
Details
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.
See Also
Other Format Data:
data_color(),
fmt_bytes(),
fmt_currency(),
fmt_datetime(),
fmt_date(),
fmt_engineering(),
fmt_fraction(),
fmt_integer(),
fmt_markdown(),
fmt_missing(),
fmt_number(),
fmt_passthrough(),
fmt_scientific(),
fmt_time(),
fmt(),
text_transform()
Examples
Run this code# NOT RUN {
# Use `pizzaplace` to create a gt table;
# format the `frac_of_quota` column to
# display values as percentages
tab_1 <-
pizzaplace %>%
dplyr::mutate(month = as.numeric(substr(date, 6, 7))) %>%
dplyr::group_by(month) %>%
dplyr::summarize(pizzas_sold = dplyr::n()) %>%
dplyr::ungroup() %>%
dplyr::mutate(frac_of_quota = pizzas_sold / 4000) %>%
gt(rowname_col = "month") %>%
fmt_percent(
columns = frac_of_quota,
decimals = 1
)
# }
Run the code above in your browser using DataLab