R: Currency formatter: round to nearest cent and display dollar...

dollar_format {scales} | R Documentation

## Currency formatter: round to nearest cent and display dollar sign.

### Description

The returned function will format a vector of values as currency. Values are rounded to the nearest cent, and cents are displayed if any of the values has a non-zero cents and the largest value is less than `largest_with_cents` which by default is 100000.

### Usage

    dollar_format(prefix = "$", suffix = "", largest_with_cents = 1e+05, ...,
      big.mark = ",", negative_parens = FALSE)

    dollar(x)

### Arguments

`prefix, suffix` | Symbols to display before and after amount.
`largest_with_cents` | the value that all values of `x` must be less than in order for the cents to be displayed
`...` | Other arguments passed on to `format`.
`big.mark` | Character used between every 3 digits.
`negative_parens` | Should negative values be shown with parentheses?
`x` | a numeric vector to format

### Value

a function with single parameter x, a numeric vector, that returns a character vector

### Examples

    dollar_format()(c(-100, 0.23, 1.456565, 2e3))
    dollar_format()(c(1:10 * 10))
    dollar(c(100, 0.23, 1.456565, 2e3))
    dollar(c(1:10 * 10))
    dollar(10^(1:8))

    usd <- dollar_format(prefix = "USD ")
    usd(c(100, -100))

    euro <- dollar_format(prefix = "", suffix = "\u20ac")
    euro(100)

    finance <- dollar_format(negative_parens = TRUE)
    finance(c(-100, 100))

[Package scales version 0.5.0 Index]