get_model_description: Get model descriptions for parsnip, workflows & modeltime...

View source: R/dev-model_descriptions.R

get_model_descriptionR Documentation

Get model descriptions for parsnip, workflows & modeltime objects

Description

Get model descriptions for parsnip, workflows & modeltime objects

Usage

get_model_description(object, indicate_training = FALSE, upper_case = TRUE)

Arguments

object

Parsnip or workflow objects

indicate_training

Whether or not to indicate if the model has been trained

upper_case

Whether to return upper or lower case model descriptions

Examples

library(dplyr)
library(timetk)
library(parsnip)
library(modeltime)

# Model Specification ----

arima_spec <- arima_reg() %>%
    set_engine("auto_arima")

get_model_description(arima_spec, indicate_training = TRUE)

# Fitted Model ----

m750 <- m4_monthly %>% filter(id == "M750")

arima_fit <- arima_spec %>%
    fit(value ~ date, data = m750)

get_model_description(arima_fit, indicate_training = TRUE)



modeltime documentation built on June 8, 2022, 1:07 a.m.