rstan_opts {EpiNow2}R Documentation

Rstan Options

Description

[Stable] Defines a list specifying the arguments passed to underlying rstan functions via rstan_sampling_opts() and rstan_vb_opts().Custom settings can be supplied which override the defaults.

Usage

rstan_opts(object = NULL, samples = 2000, method = "sampling", ...)

Arguments

object

Stan model object. By default uses the compiled package default.

samples

Numeric, default 2000. Overall number of posterior samples. When using multiple chains iterations per chain is samples / chains.

method

A character string, defaulting to sampling. Currently supports rstan::sampling ("sampling") or rstan:vb ("vb").

...

Additional parameters to pass underlying option functions.

Value

A list of arguments to pass to the appropriate rstan functions.

Author(s)

Sam Abbott

See Also

rstan_sampling_opts rstan_vb_opts

Examples

rstan_opts(samples = 1000)

# using vb
rstan_opts(method = "vb")

[Package EpiNow2 version 1.4.0 Index]