dcoptions: Setting Options

Description Usage Arguments Details Value Author(s) Examples

View source: R/dcoptions.R

Description

Setting options.

Usage

1

Arguments

...

Arguments in tag = value form, or a list of tagged values. The tags must come from the parameters described below.

Details

dcoptions is a convenient way of handling options related to the package.

Value

When parameters are set by dcoptions, their former values are returned in an invisible named list. Such a list can be passed as an argument to dcoptions to restore the parameter values. Tags are the following:

autoburnin

logical, to use in gelman.diag (default is TRUE).

diag

critical value to use for data cloning convergence diagnostics, default is 0.05.

LB

logical, should load balancing be used, default is FALSE.

overwrite

logical, should existing model file be overwritten, default is TRUE.

rhat

critical value for testing chain convergence, default is 1.1.

RNG

parallel RNG type, either "none" (default), "RNGstream" or "SPRNG", see clusterSetupRNG.

verbose

integer, should output be verbose (>0) or not (0), default is 1.

Author(s)

Peter Solymos, solymos@ualberta.ca

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## set LB option, but store old value
ov <- dcoptions("LB"=TRUE)
## this is old value
ov
## this is new value
getOption("dcoptions")
## reset to old value
dcoptions(ov)
## check reset
getOption("dcoptions")

dclone documentation built on May 2, 2019, 6:08 p.m.