R: openxlsx Options

openxlsx_options {openxlsx} | R Documentation

## openxlsx Options

### Description

See and get the openxlsx options

### Usage

    op.openxlsx

    openxlsx_getOp(x, default = NULL)

    openxlsx_setOp(x, value)

### Arguments

`x` | An option name (`"openxlsx."` prefix optional)
`default` | A default value if `NULL`
`value` | The new value for the option (optional if x is a named list)

### Format

An object of class `list` of length 34.

### Details

`openxlsx_getOp()` retrieves the `"openxlsx"` options found in `op.openxlsx`. If none are set (currently `NULL`) retrieves the default option from `op.openxlsx`. This will also check that the intended option is a standard option (listed in `op.openxlsx`) and will provide a warning otherwise.

`openxlsx_setOp()` is a safer way to set an option as it will first check that the option is a standard option (as above) before setting.

### Examples

    openxlsx_getOp("borders")
    op.openxlsx[["openxlsx.borders"]]

[Package openxlsx version 4.2.5 Index]