Model: Model class

In dymium-org/dymiumCore: A Toolkit for Building a Dynamic Microsimulation Model for Integrated Urban Modelling

Description

A container for the supported model objects (see SupportedTransitionModels). When a model object is stored inside Model it can be assess using reference semantics. This is particularly useful when you want to store model objects inside World. By doing so, you can assess those models from World as it is flowing down a microsimulation pipeline just like Entities.

Usage

## S3 method for class 'Model'
summary(object, ...)

Arguments

object	a Model object
...	dots

Format

R6::R6Class object inheriting Generic.

Construction

x <- Model$new(x, name = NULL, preprocessing_fn = NULL)

• x :: (caret::train | data.table::data.table | named list)
  A model object that compatible.

• name :: character(1)
  Name/Alias of the model.

• preprocessing_fn :: function()
  A function that will be used to preprocess simulation data. E.g., this can be used to filter which agents the model is applicable for.

Active field

• model
  (read-only) The stored model object in its original form.

• name :: character(1)
  Name/Alias of the model.

Public fields

• preprocessing_fn
  Default as NULL, this is to store a preprocessing function which will be used to evaluate the entity data in Trans prior to simulating the transition. A situation where this is useful could be when you want to limit the use of a Model object to the specific group of agents (e.g: age between x and y) that was used to estimate the model.

Public Methods

• get()
  () -> (caret::train | data.table::data.table | named list)
  Get a model object.

• set(x)
  (caret::train | data.table::data.table | named list)
  Get a model object.

• modify()
  An abstract method.

• simulate()
  An abstract method.

• print()
  

Examples

simple_prob_model <- Model$new(x = list(yes = 0.95, no = 0.05))

simple_glm_model <- Model$new(x = stats::glm(factor(sex) ~ age,
  data = toy_individuals, family = "binomial"
))

# return the original model object
simple_prob_model$model

# add to world
world <- World$new()

world$add(simple_prob_model, name = "simple_prob_model")
world$add(simple_glm_model, name = "simple_glm_model")

# to access
world$get("simple_prob_model")
world$get("simple_glm_model")

# or alternatively you can use `get_model` which makes sure that it only looks
# through the named list of stored Model objects inside [World].
world$get_model("simple_prob_model")
world$get_model("simple_glm_model")

dymium-org/dymiumCore documentation built on July 18, 2021, 5:10 p.m.