format_decimal-deprecated {formatdown} | R Documentation |
Format decimal or integer values
Description
This function is deprecated because it's a special case of the new
format_numbers()
function. In addition, the new function includes features
not available in the deprecated function.
Usage
format_decimal(x, digits, ..., big_mark, delim)
Arguments
x |
Numeric vector to be formatted. |
digits |
Numeric scalar, decimal places to report, integer between 0 and 20. Zero returns an integer. |
... |
Not used, force later arguments to be used by name. |
big_mark |
Character. If not empty, used as mark between every three
digits before the decimal point. Applied as the |
delim |
Character vector (length 1 or 2) defining the delimiters for
marking up inline math. Possible values include |
Details
Convert the elements of a numerical vector to character strings in which the numbers are formatted using decimal notation and delimited for rendering as inline equations in an R Markdown document.
Given a number, a numerical vector, or a numerical column from a data frame,
format_decimal()
converts the numbers to character strings of the form,
"$a$"
, where a
is the number in decimal notation. The user can specify
the number of decimal places.
Delimiters for inline math markup can be edited if necessary. If the default
argument fails, the "\\("
alternative is available. If using a custom
delimiter to suit the markup environment, be sure to escape all special
symbols.
Value
A character vector with numbers represented in decimal notation and delimited as inline math markup.