tablesggOpt: Get or Reset Package Options

View source: R/tablesggOpt.bare.R

tablesggOptR Documentation

Get or Reset Package Options

Description

Get the values of package options, or reset all options to their "factory-fresh" defaults.

Usage

tablesggOpt(x=NULL, reset=FALSE)

Arguments

x

Character string with the name of a single package option, or NULL.

reset

Logical scalar. If TRUE, all options will be reset to their initial, "factory-fresh" values.

Details

The user can change option values using the tablesggSetOpt function. The new values will stay in effect for the rest of the R session or until they are changed again by the user.

Value

If x is the name of a single package option, the value of that option. Otherwise, a named list with the current values of all package options. In both cases the result is after resetting if reset is TRUE.

The result is invisible if reset is TRUE.

The available options are documented in ?tablesggSetOpt.

See Also

tablesggSetOpt, styles_pkg

Examples

  # See names of available options:
  names(tablesggOpt())
  # The current value of option 'plot.margin':
  tablesggOpt("plot.margin")
  

tablesgg documentation built on June 22, 2024, 11:02 a.m.