DataModel: Create a DataModel object, describing the relationship of...

Description Usage Arguments Details Value Examples

View source: R/dataModel.R

Description

Create a DataModel object, describing the relationship of your data to the SEIR model

Usage

1
2
3
4
5
6
7
DataModel(
  Y,
  type = c("identity", "overdispersion"),
  compartment = c("I_star", "R_star", "I"),
  cumulative = FALSE,
  params = list()
)

Arguments

Y

A matrix with T rows and n columns, for time points and spatial locations respectively.

type

A string equal to "identity", "overdispersion", or "fractional"

compartment

A string equal to "I_star" or "R_star"

cumulative

A logical value indicating whether the data is reported on a cumulative scale

params

A list of optional parameters

Details

A fundamental task in building hierarchical models is to describe the way in which the observed data relates to the underlying model. Here, we assume that the matrix of observed values, Y, is related to one of two epidemic compartments: I_star or R_star. In the notation of Brown, Porter, and Oleson 2015, these correspond to the $I^*$ and $R^*$ compartments, which catalog the newly infectious and recovered individuals, respectively. For a discussion of these definitions, in addition to a more detailed description of the overall spatial SEIR framework, please refer to that work. Depending on the data model type, additional parameters may be required:

Value

an object of type DataModel

Examples

1
dataModel = DataModel(rpois(100, 10)) 

grantbrown/ABSEIR documentation built on Oct. 14, 2021, 2:32 p.m.