ModelCustom: ModelCustom

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

Description

A ModelCustom class.

print method.

an abstract method. Once implemented it should accept newdata as the first argument and returns a numeric() vector or a data.frame() that contains the predicted probabilities calculated using self$params and newdata.

summary method.

Usage

## S3 method for class 'ModelCustom'
predict(object, newdata, ...)

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

Arguments

object	a ModelCustom object
newdata	a data.frame/data.table
...	not being used.

Format

an R6::R6Class class inheriting from Model.

Value

prediction

summary

Public fields

• params :: named numeric()
  A named numeric vector containing parameter values of the model object.

• type :: character(1)
  Type of the model.

• formula :: formula()
  Model formula.

• terms :: character(1)
  terms of the model. This gets generated using stats::terms on formula

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