model: Create Forecast Model

Description Usage Arguments Value Examples

View source: R/models.R

Description

Constructor function to create a model class object for use with seer function. Creates an model object after assertions on the algorithm input. Used to standarize the model inputs

Usage

1
2
model(algo, args = list(), pipe = madutils::pipeline(),
  uid = madutils::random_string("model"), desc = "")

Arguments

algo

model algorithm string. ex - 'auto.arima'

args

list of model arguments. default is empty list

pipe

model pipeline. default is identity

uid

optional sting uid argument. default is random_string

desc

optional description

Value

model class object

Examples

1
model(algo = "auto.arima", args = list(), uid = "my-model", desc = "example description")

chrishaarstick/mad4sight documentation built on May 6, 2019, 4:31 p.m.