EpiNow2 (version 1.3.4)

create_stan_args: Create a List of Stan Arguments

Description

Generates a list of arguments as required by rstan::sampling or rstan::vb by combining the required options, with data, and type of initialisation. Initialisation defaults to random but it is expected that create_initial_conditions will be used.

Usage

create_stan_args(
  stan = stan_opts(),
  data = NULL,
  init = "random",
  verbose = FALSE
)

Value

A list of stan arguments

Arguments

stan

A list of stan options as generated by stan_opts(). Defaults to stan_opts(). Can be used to override data, init, and verbose settings if desired.

data

A list of stan data as created by create_stan_data

init

Initial conditions passed to rstan. Defaults to "random" but can also be a function ( as supplied by create_intitial_conditions).

verbose

Logical, defaults to FALSE. Should verbose progress messages be returned.

Author

Sam Abbott

Examples

# default settings
create_stan_args()

# increasing warmup
create_stan_args(stan = stan_opts(warmup = 1000))