R: NIMBLE Options Settings

nimbleOptions {nimble} | R Documentation

## NIMBLE Options Settings

### Description

Allow the user to set and examine a variety of global _options_ that affect the way in which NIMBLE operates. Call `nimbleOptions()` with no arguments to see a list of available opions.

### Usage

    nimbleOptions(...)

### Arguments

`...` | any options to be defined as one or more `name = value` pairs or as a single `list` of `name=value` pairs.

### Details

`nimbleOptions` mimics `options`. Invoking `nimbleOptions()` with no arguments returns a list with the current values of the options. To access the value of a single option, one should use `getNimbleOption()`.

### Value

When invoked with no arguments, returns a list with the current values of all options. When invoked with one or more arguments, returns a list of the the updated options with their updated values.

### Author(s)

Christopher Paciorek

### Examples

    # Set one option:
    nimbleOptions(verifyConjugatePosteriors = FALSE)

    # Compactly print all options:
    str(nimbleOptions(), max.level = 1)

    # Save-and-restore options:
    old <- nimbleOptions()                    # Saves old options.
    nimbleOptions(showCompilerOutput = TRUE,
                  verboseErrors = TRUE)       # Sets temporary options.
    # ...do stuff...
    nimbleOptions(old)                        # Restores old options.

[Package nimble version 0.9.1 Index]