The DiseasyModelGLM module implements common structure and functionality to
GLM regression class of models beyond the model structure provided by DiseasyModelRegression.
Most notably, the model module implements the $fit_regression() and $get_prediction() methods using
GLM.
diseasy includes two simple models that uses the DiseasyModelGLM module:
DiseasyModelG0 and DiseasyModelG1
These models implements a constant predictor and a exponential model based on the previous 7 and 21 days
of observations, respectively.
When making a custom GLM model, the subclass should implement the $update_formula() method.
The $update_formula() method should update the formula based on the stratifications.
If the model should flexibly adapt to different stratifications, this method should be implemented.
See DiseasyModelG0 and DiseasyModelG1 for
examples of how this can be done.
Value
A new instance of the DiseasyModelGLM, DiseasyModelG0 or
DiseasyModelG1 R6 class.
Super classes
diseasy::DiseasyBaseModule -> diseasy::DiseasyModel -> diseasy::DiseasyModelRegression -> DiseasyModelBRM
Methods
Method new()
Creates a new instance of the DiseasyModelBRM R6 class.
This module is typically not constructed directly but rather through DiseasyModelB* classes,
such as DiseasyModelB0 and DiseasyModelB1.
Usage
DiseasyModelBRM$new(...)Arguments
...parameters sent to
DiseasyModelRegressionR6 constructor.
Details
Helper class for the the DiseasyModelB* R6 classes.
Returns
A new instance of the DiseasyModelBRM R6 class.
Super classes
diseasy::DiseasyBaseModule -> diseasy::DiseasyModel -> diseasy::DiseasyModelRegression -> diseasy::DiseasyModelBRM -> diseasy::NA -> DiseasyModelB0
Methods
Method new()
Usage
DiseasyModelB0$new(...)Arguments
...parameters sent to
DiseasyModelB_R6 constructor
Returns
A new instance of the DiseasyModelB0 R6 class.
Super classes
diseasy::DiseasyBaseModule -> diseasy::DiseasyModel -> diseasy::DiseasyModelRegression -> diseasy::DiseasyModelBRM -> diseasy::NA -> DiseasyModelB1
Methods
Method new()
Usage
DiseasyModelB1$new(...)Arguments
...parameters sent to
DiseasyModelB_R6 constructor
Returns
A new instance of the DiseasyModelB1 R6 class.
Examples
model <- DiseasyModelG0$new()
rm(model)
