With numeric values in a gt table, we can transform those to values of
bytes with human readable units. The 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
fmt_bytes( data, columns, rows = everything(), 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 )
| data | A table object that is created using the |
|---|---|
| columns | The columns to format. Can either be a series of column names
provided in |
| rows | Optional rows to format. Providing either |
| 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 |
| n_sigfig | A option to format numbers to n significant figures. By
default, this is |
| 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, |
| use_seps | An option to use digit group separators. The type of digit
group separator is set by |
| pattern | A formatting pattern that allows for decoration of the
formatted value. The value itself is represented by |
| sep_mark | The mark to use as a separator between groups of digits
(e.g., using |
| dec_mark | The character to use as a decimal mark (e.g., using |
| force_sign | Should the positive sign be shown for positive numbers
(effectively showing a sign for all numbers except zero)? If so, use |
| incl_space | An option for whether to include a space between the value
and the units. The default of |
| locale | An optional locale ID that can be used for formatting the value
according the locale's rules. Examples include |
An object of class gt_tbl.
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.
3-7
Other Format Data:
data_color(),
fmt_currency(),
fmt_datetime(),
fmt_date(),
fmt_engineering(),
fmt_integer(),
fmt_markdown(),
fmt_missing(),
fmt_number(),
fmt_passthrough(),
fmt_percent(),
fmt_scientific(),
fmt_time(),
fmt(),
text_transform()
# Use `exibble` to create a gt table; # format the `num` column to have # byte sizes in the binary standard tab_1 <- exibble %>% dplyr::select(num) %>% gt() %>% fmt_bytes(columns = num) # Create a similar table with the # `fmt_bytes()` function, this time # showing byte sizes as binary values tab_2 <- exibble %>% dplyr::select(num) %>% gt() %>% fmt_bytes( columns = num, standard = "binary" )