rstan (version 2.9.0-3)

rstan_options: Set and read options used in RStan

Description

Set and read options used in RStan. Some settings as options can be controlled by the user.

Usage

rstan_options(...)

Arguments

...

Arguments of the form opt = val set option opt to value val. Arguments of the form opt set the function to return option opt's value. Each argument must be a character string.

Value

• The values as a list for existing options and NA for non-existent options. When only one option is specified, its old value is returned.

Details

The available options are:

1. plot_rhat_breaks: The cut off points for Rhat for which we would indicate using a different color. This is a numeric vector, defaulting toc(1.1, 1.2, 1.5, 2). The value for this option will be sorted in ascending order, so for exampleplot_rhat_breaks = c(1.2, 1.5)is equivalent toplot_rhat_breaks = c(1.5, 1.2).
2. plot_rhat_cols: A vector of the same length asplot_rhat_breaksthat indicates the colors for the breaks.
3. plot_rhat_nan_col: The color for Rhat when it isInforNaN.
4. plot_rhat_large_col: The color for Rhat when it is larger than the largest value ofplot_rhat_breaks.
5. rstan_alert_col: The color used in methodplotof S4 classstanfitto show that the vector/array parameters are truncated.
6. rstan_chain_cols: The colors used in methodsplotandtraceplotof S4 classstanfitfor coloring different chains.
7. rstan_warmup_bg_col: The background color for the warmup area in the traceplots.
8. boost_lib: The path for the Boost C++ library used to compile Stan models. This option is valid for the wholeRsession if not changed again.
9. eigen_lib: The path for the Eigen C++ library used to compile Stan models. This option is valid for the wholeRsession if not changed again.
10. auto_write: A logical scalar (defaulting toFALSE) that controls whether a compiled instance of astanmodel-classis written to the hard disk in the same directory as the.stanprogram.