With numeric values in a vector, we can transform each into byte values with
human readable units. The vec_fmt_bytes()
function allows for the
formatting of byte sizes to either of two common representations: (1) with
decimal units (powers of 1000, examples being "kB"
and "MB"
), and (2)
with binary units (powers of 1024, examples being "KiB"
and "MiB"
).
It is assumed the input numeric values represent the number of bytes and automatic truncation of values will occur. The numeric values will be scaled to be in the range of 1 to <1000 and then decorated with the correct unit symbol according to the standard chosen. For more control over the formatting of byte sizes, we can use the following options:
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
vec_fmt_bytes(
x,
standard = c("decimal", "binary"),
decimals = 1,
n_sigfig = NULL,
drop_trailing_zeros = TRUE,
drop_trailing_dec_mark = TRUE,
use_seps = TRUE,
pattern = "{x}",
sep_mark = ",",
dec_mark = ".",
force_sign = FALSE,
incl_space = TRUE,
locale = NULL,
output = c("auto", "plain", "html", "latex", "rtf", "word")
)
Arguments
- x
A numeric vector.
- standard
The way to express large byte sizes.
- decimals
An option to specify the exact number of decimal places to use. The default number of decimal places is
1
.- n_sigfig
A option to format numbers to n significant figures. By default, this is
NULL
and thus number values will be formatted according to the number of decimal places set viadecimals
. If opting to format according to the rules of significant figures,n_sigfig
must be a number greater than or equal to1
. Any values passed to thedecimals
anddrop_trailing_zeros
arguments will be ignored.- drop_trailing_zeros
A logical value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).
- drop_trailing_dec_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
becomes23.
). The default for this isTRUE
, which means that trailing decimal marks are not shown.- 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.- 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
).- dec_mark
The character to use as a decimal mark (e.g., using
dec_mark = ","
with0.152
would result in a formatted value of0,152
).- force_sign
Should the positive sign be shown for positive numbers (effectively showing a sign for all numbers except zero)? If so, use
TRUE
for this option. The default isFALSE
, where only negative numbers will display a minus sign.- incl_space
An option for whether to include a space between the value and the units. The default of
TRUE
uses a space character for separation.- 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.- output
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(3.24294e14, 8, 1362902, -59027, NA)
Using vec_fmt_bytes()
with the default options will create a character
vector with values in bytes. Any NA
values remain as NA
values. The
rendering context will be autodetected unless specified in the output
argument (here, it is of the "plain"
output type).
vec_fmt_bytes(num_vals)
We can change the number of decimal places with the decimals
option:
vec_fmt_bytes(num_vals, decimals = 2)
If we are formatting for a different locale, we could supply the locale ID and gt will handle any locale-specific formatting options:
vec_fmt_bytes(num_vals, locale = "fi")
Should you need to have positive and negative signs on each of the output
values, use force_sign = TRUE
:
vec_fmt_bytes(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_bytes(num_vals, pattern = "[{x}]")
See also
Other vector formatting functions:
vec_fmt_currency()
,
vec_fmt_datetime()
,
vec_fmt_date()
,
vec_fmt_duration()
,
vec_fmt_engineering()
,
vec_fmt_fraction()
,
vec_fmt_integer()
,
vec_fmt_markdown()
,
vec_fmt_number()
,
vec_fmt_partsper()
,
vec_fmt_percent()
,
vec_fmt_roman()
,
vec_fmt_scientific()
,
vec_fmt_time()