DataFormat: Create an DataFormat object.

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/DataFormat.R

Description

Create an DataFormat object, useful when working with cell styles.

Usage

1
2
3

Arguments

x

a character value specifying the data format.

df

An DataFormat object, as returned by DataFormat.

Details

Specifying the dataFormat argument allows you to format the cell. For example, "#,##0.00" corresponds to using a comma separator for powers of 1000 with two decimal places, "m/d/yyyy" can be used to format dates and is the equivalent of R's MM/DD/YYYY format. To format datetimes use "m/d/yyyy h:mm:ss;@". To show negative values in red within parentheses with two decimals and commas after power of 1000 use "#,##0.00_);[Red](#,##0.00)". I am not aware of an official way to discover these strings. I find them out by recording a macro that formats a specific cell and then checking out the resulting VBA code. From there you can read the dataFormat code.

Value

DataFormat returns a list one component dataFormat, and a class attribute "DataFormat". DataFormat objects are used when constructing cell styles.

is.DataFormat returns TRUE if the argument is of class "DataFormat" and FALSE otherwise.

Author(s)

Adrian Dragulescu

See Also

CellStyle for using the a DataFormat object.

Examples

1
  df <-  DataFormat("#,##0.00")

colearendt/xlsx documentation built on Oct. 11, 2018, 12:23 a.m.