With numeric values in a vector, we can perform currency-based formatting.
This function supports both automatic formatting with a three-letter or
numeric currency code. We can also specify a custom currency that is
formatted according to the output context with the currency()
helper
function. We have fine control over the conversion from numeric values to
currency values, where we could take advantage of the following options:
the currency: providing a currency code or common currency name will procure the correct currency symbol and number of currency subunits; we could also use the
currency()
helper function to specify a custom currencycurrency symbol placement: the currency symbol can be placed before or after the values
decimals/subunits: choice of the number of decimal places, and a choice of the decimal symbol, and an option on whether to include or exclude the currency subunits (decimal portion)
negative values: choice of a negative sign or parentheses for values less than zero
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 currency values
locale-based formatting: providing a locale ID will result in currency formatting specific to the chosen locale; it will also retrieve the locale's currency if none is explicitly given
We can call info_currencies()
for a useful reference on all of the possible
inputs to the currency
argument.
Usage
vec_fmt_currency(
x,
currency = NULL,
use_subunits = TRUE,
decimals = NULL,
drop_trailing_dec_mark = TRUE,
use_seps = TRUE,
accounting = FALSE,
scale_by = 1,
suffixing = FALSE,
pattern = "{x}",
sep_mark = ",",
dec_mark = ".",
force_sign = FALSE,
placement = "left",
incl_space = FALSE,
locale = NULL,
output = c("auto", "plain", "html", "latex", "rtf", "word")
)
Arguments
- x
The input vector
vector(numeric|integer)
// requiredThis is the input vector that will undergo transformation to a character vector of the same length. Values within the vector will be formatted.
- currency
Currency to use
scalar<character>|obj:<gt_currency>
// default:NULL
(optional
)The currency to use for the numeric value. This input can be supplied as a 3-letter currency code (e.g.,
"USD"
for U.S. Dollars,"EUR"
for the Euro currency). Useinfo_currencies()
to get an information table with all of the valid currency codes and examples of each. Alternatively, we can provide a common currency name (e.g.,"dollar"
,"pound"
,"yen"
, etc.) to simplify the process. Useinfo_currencies()
with thetype == "symbol"
option to view an information table with all of the supported currency symbol names along with examples.We can also use the
currency()
helper function to specify a custom currency, where the string could vary across output contexts. For example, usingcurrency(html = "ƒ", default = "f")
would give us a suitable glyph for the Dutch guilder in an HTML output table, and it would simply be the letter "f" in all other output contexts). Please note thatdecimals
will default to2
when using thecurrency()
helper function.- use_subunits
Show or hide currency subunits
scalar<logical>
// default:TRUE
An option for whether the subunits portion of a currency value should be displayed. For example, with an input value of
273.81
, the default formatting will produce"$273.81"
. Removing the subunits (withuse_subunits = FALSE
) will give us"$273"
.- decimals
Number of decimal places
scalar<numeric|integer>(val>=0)
// default:NULL
(optional
)The
decimals
values corresponds to the exact number of decimal places to use. This value is optional as a currency has an intrinsic number of decimal places (i.e., the subunits). A value such as2.34
can, for example, be formatted with0
decimal places and if the currency used is"USD"
it would result in"$2"
. With4
decimal places, the formatted value becomes"$2.3400"
.- drop_trailing_dec_mark
Drop the trailing decimal mark
scalar<logical>
// default:TRUE
A logical value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting. For example, when
use_subunits = FALSE
ordecimals = 0
a formatted value such as"$23"
can be fashioned as"$23."
by settingdrop_trailing_dec_mark = FALSE
.- use_seps
Use digit group separators
scalar<logical>
// default:TRUE
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
Use accounting style
scalar<logical>
// default:FALSE
An option to use accounting style for values. Normally, negative values will be shown with a minus sign but using accounting style will instead put any negative values in parentheses.
- scale_by
Scale values by a fixed multiplier
scalar<numeric|integer>
// default:1
All numeric values will be multiplied by the
scale_by
value before undergoing formatting. Since thedefault
value is1
, no values will be changed unless a different multiplier value is supplied. This value will be ignored if using any of thesuffixing
options (i.e., wheresuffixing
is not set toFALSE
).- suffixing
Specification for large-number suffixing
scalar<logical>|vector<character>
// default:FALSE
The
suffixing
option allows us to scale and apply suffixes to larger numbers (e.g.,1924000
can be transformed to1.92M
). 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 alternatively provide a character vector that serves as a specification for which symbols are to used for each of the value ranges. These preferred symbols will replace the defaults (e.g.,
c("k", "Ml", "Bn", "Tr")
replaces"K"
,"M"
,"B"
, and"T"
).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 at all 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.If using
system = "ind"
then the default suffix set provided bysuffixing = TRUE
will be the equivalent ofc(NA, "L", "Cr")
. This doesn't apply suffixes to the thousands range, but does express values in lakhs and crores.- 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.- sep_mark
Separator mark for digit grouping
scalar<character>
// default:","
The string to use as a separator between groups of digits. For example, using
sep_mark = ","
with a value of1000
would result in a formatted value of"1,000"
. This argument is ignored if alocale
is supplied (i.e., is notNULL
).- dec_mark
Decimal mark
scalar<character>
// default:"."
The string to be used as the decimal mark. For example, using
dec_mark = ","
with the value0.152
would result in a formatted value of"0,152"
). This argument is ignored if alocale
is supplied (i.e., is notNULL
).- force_sign
Forcing the display of a positive sign
scalar<logical>
// default:FALSE
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
.- placement
Currency symbol placement
singl-kw:[left|right]
// default:"left"
The placement of the currency symbol. This can be either be
"left"
(as in"$450"
) or"right"
(which yields"450$"
).- incl_space
Include a space between the value and the currency symbol
scalar<logical>
// default:FALSE
An option for whether to include a space between the value and the currency symbol. The default is to not introduce a space character.
- 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 callinfo_locales()
for a useful reference for all of the locales that are supported.- output
Output format
singl-kw:[auto|plain|html|latex|rtf|word]
// default:"auto"
The output style of the resulting character vector. This can either be
"auto"
(the default),"plain"
,"html"
,"latex"
,"rtf"
, or"word"
. In knitr rendering (i.e., Quarto or R Markdown), the"auto"
option will choose the correctoutput
value
Examples
Let's create a numeric vector for the next few examples:
num_vals <- c(5.2, 8.65, 0, -5.3, NA)
Using vec_fmt_currency()
with the default options will create a character
vector where the numeric values have been transformed to U.S. Dollars
("USD"
). Furthermore, the rendering context will be autodetected unless
specified in the output
argument (here, it is of the "plain"
output
type).
vec_fmt_currency(num_vals)
We can supply a currency code to the currency
argument. Let's use British
Pounds through currency = "GBP"
:
vec_fmt_currency(num_vals, currency = "GBP")
If we are formatting for a different locale, we could supply the locale ID and let gt handle all locale-specific formatting options:
vec_fmt_currency(num_vals, locale = "fr")
There are many options for formatting values. Perhaps you need to have
explicit positive and negative signs? Use force_sign = TRUE
for that.
vec_fmt_currency(num_vals, force_sign = TRUE)
As a last example, one can wrap the values in a pattern with the pattern
argument. Note here that NA
values won't have the pattern applied.
vec_fmt_currency(num_vals, pattern = "`{x}`")
See also
The variant function intended for formatting gt table data:
fmt_currency()
.
Other vector formatting functions:
vec_fmt_bytes()
,
vec_fmt_date()
,
vec_fmt_datetime()
,
vec_fmt_duration()
,
vec_fmt_engineering()
,
vec_fmt_fraction()
,
vec_fmt_index()
,
vec_fmt_integer()
,
vec_fmt_markdown()
,
vec_fmt_number()
,
vec_fmt_partsper()
,
vec_fmt_percent()
,
vec_fmt_roman()
,
vec_fmt_scientific()
,
vec_fmt_spelled_num()
,
vec_fmt_time()