Skip to contents

Create Time-varying Reproduction Number Data

Source: R/create.R
create_rt_data.Rd

[Stable] Takes the output from rt_opts() and converts it into a list understood by stan.

Usage

create_rt_data(
  rt = rt_opts(),
  breakpoints = NULL,
  delay = 0,
  horizon = 0,
  data = NULL
)

Arguments

rt

A list of options as generated by rt_opts() defining Rt estimation. Defaults to rt_opts(). To generate new infections using the non-mechanistic model instead of the renewal equation model, use rt = NULL. The non-mechanistic model internally uses the setting rt = rt_opts(use_rt = FALSE, future = "project", gp_on = "R0").

breakpoints

An integer vector (binary) indicating the location of breakpoints.

delay

Numeric mean delay

horizon

Numeric, forecast horizon.

data

A data.table of case data (optional). Used for validation checks.

Value

A list of settings defining the time-varying reproduction number

See also

rt_opts()

Examples

if (FALSE) { # \dontrun{
# default Rt data
create_rt_data()

# settings when no Rt is desired
create_rt_data(rt = NULL)

# using breakpoints
create_rt_data(rt_opts(use_breakpoints = TRUE), breakpoints = rep(1, 10))

# using random walk
create_rt_data(rt_opts(rw = 7), breakpoints = rep(1, 10))
} # }