formatInt: Format an integer as a string

In jmw86069/jamba: Jam Base Methods

Format an integer as a string

Description

Format an integer as a string

Usage

formatInt(
  x,
  big.mark = ",",
  trim = TRUE,
  forceInteger = TRUE,
  scientific = FALSE,
  ...
)

Arguments

x	numeric vector or matrix
big.mark, trim, scientific	options sent to base::format() but configured with defaults intended for integer values.
forceInteger	logical indicating whether numeric values should be rounded to the nearest integer value prior to base::format(). This option is intended to hide decimal values where they are not informative.

Details

This function is a quick wrapper function around base::format() to display integer values as text strings. It will also return a matrix if the input is a matrix.

Value

character vector if x is a vector, or if x is a matrix a matrix will be returned.

See Also

Other jam string functions: asSize(), breaksByVector(), cPasteSU(), cPasteS(), cPasteUnique(), cPasteU(), cPaste(), fillBlanks(), gsubOrdered(), gsubs(), makeNames(), mixedOrder(), mixedSortDF(), mixedSorts(), mixedSort(), mmixedOrder(), nameVectorN(), nameVector(), padInteger(), padString(), pasteByRowOrdered(), pasteByRow(), sizeAsNum(), tcount(), ucfirst(), uniques()

Examples

x <- c(1234, 1234.56, 1234567.89);
## By default, commas are used for big.mark, and decimal values are hidden
formatInt(x);

## By default, commas are used for big.mark
formatInt(x, forceInteger=FALSE);

jmw86069/jamba documentation built on March 26, 2024, 5:26 a.m.