vec_fmt_engineering  R Documentation 
With numeric values in a vector, we can perform formatting so that the
targeted values are rendered in engineering notation, where numbers are
written in the form of a mantissa (m
) and an exponent (n
). When combined
the construction is either of the form m x 10^n or mEn. The mantissa
is a number between 1
and 1000
and the exponent is a multiple of 3
. For
example, the number 0.0000345 can be written in engineering notation as
34.50 x 10^6
. This notation helps to simplify calculations and make it
easier to compare numbers that are on very different scales.
We have fine control over the formatting task, with the following options:
decimals: choice of the number of decimal places, option to drop trailing zeros, and a choice of the decimal symbol
scaling: we can choose to scale targeted values by a multiplier value
pattern: option to use a text pattern for decoration of the formatted values
localebased formatting: providing a locale ID will result in formatting specific to the chosen locale
vec_fmt_engineering(
x,
decimals = 2,
drop_trailing_zeros = FALSE,
drop_trailing_dec_mark = TRUE,
scale_by = 1,
exp_style = "x10n",
pattern = "{x}",
sep_mark = ",",
dec_mark = ".",
force_sign_m = FALSE,
force_sign_n = FALSE,
locale = NULL,
output = c("auto", "plain", "html", "latex", "rtf", "word")
)
x 
The input vector
This is the input vector that will undergo transformation to a character vector of the same length. Values within the vector will be formatted. 
decimals 
Number of decimal places
This corresponds to the exact number of decimal places to use. A value
such as 
drop_trailing_zeros 
Drop any trailing zeros
A logical value that allows for removal of trailing zeros (those redundant zeros after the decimal mark). 
drop_trailing_dec_mark 
Drop the trailing 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., 
scale_by 
Scale values by a fixed multiplier
All numeric values will be multiplied by the 
exp_style 
Style declaration for exponent formatting
Style of formatting to use for the scientific notation formatting. By
default this is 
pattern 
Specification of the formatting pattern
A formatting pattern that allows for decoration of the formatted value. The
formatted value is represented by the 
sep_mark 
Separator mark for digit grouping
The string to use as a separator between groups of digits. For example,
using 
dec_mark 
Decimal mark
The string to be used as the decimal mark. For example, using

force_sign_m , force_sign_n 
Forcing the display of a positive sign
Should the plus sign be shown for positive values of the mantissa (first
component, 
locale 
Locale identifier
An optional locale identifier that can be used for formatting values
according the locale's rules. Examples include 
output 
Output format
The output style of the resulting character vector. This can either be

A character vector.
Let's create a numeric vector for the next few examples:
num_vals < c(3.24e4, 8.65, 1362902.2, 59027.3, NA)
Using vec_fmt_engineering()
with the default options will create a
character vector with values engineering notation. 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_engineering(num_vals)
#> [1] "324.00 × 10^6" "8.65" "1.36 × 10^6" "59.03 × 10^3" "NA"
We can change the number of decimal places with the decimals
option:
vec_fmt_engineering(num_vals, decimals = 1)
#> [1] "324.0 × 10^6" "8.7" "1.4 × 10^6" "59.0 × 10^3" "NA"
If we are formatting for a different locale, we could supply the locale ID and gt will handle any localespecific formatting options:
vec_fmt_engineering(num_vals, locale = "da")
#> [1] "324,00 × 10^6" "8,65" "1,36 × 10^6" "59,03 × 10^3" "NA"
Should you need to have positive and negative signs for the mantissa
component of a given value, use force_sign_m = TRUE
:
vec_fmt_engineering(num_vals, force_sign_m = TRUE)
#> [1] "+324.00 × 10^6" "+8.65" "+1.36 × 10^6" "59.03 × 10^3" "NA"
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_engineering(num_vals, pattern = "/{x}/")
#> [1] "/324.00 × 10^6/" "/8.65/" "/1.36 × 10^6/" "/59.03 × 10^3/" "NA"
154
v0.7.0
(Aug 25, 2022)
The variant function intended for formatting gt table data:
fmt_engineering()
.
Other vector formatting functions:
vec_fmt_bytes()
,
vec_fmt_currency()
,
vec_fmt_datetime()
,
vec_fmt_date()
,
vec_fmt_duration()
,
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()
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.