R/data.R

In epicmodel: Causal Modeling in Epidemiology

#' Birthday party example steplist
#'
#' An example steplist, which contains the steps that tell Clara, under which conditions her birthday party will be a success.
#'
#' @format An object of class `epicmodel_steplist`, which is a list of 8 data.frames. See [new_steplist()] for the detailed structure of
#' `epicmodel_steplist` class objects.
#'
"steplist_party"

#' Rain example steplist
#'
#' An example steplist, which contains a rain-themed example to illustrate intervention functions.
#'
#' @format An object of class `epicmodel_steplist`, which is a list of 8 data.frames. See [new_steplist()] for the detailed structure of
#' `epicmodel_steplist` class objects.
#'
"steplist_rain"

#' Rain example SCC model
#'
#' An example SCC model created from `steplist_rain`.
#'
#' @format An object of class `epicmodel_scc`, which is a list of 10 elements. See [new_scc()] for the detailed structure of
#' `epicmodel_scc` class objects.
#'
"scc_rain"