type_sum.model_spec: Succinct summary of parsnip object

View source: R/type_sum.R

type_sum.model_specR Documentation

Succinct summary of parsnip object

Description

type_sum controls how objects are shown when inside tibble columns.

Usage

## S3 method for class 'model_spec'
type_sum(x)

## S3 method for class 'model_fit'
type_sum(x)

Arguments

x

A model_spec or model_fit object to summarise.

Details

For model_spec objects, the summary is "spec[?]" or "spec[+]". The former indicates that either the model mode has not been declared or that the specification has tune() parameters. Otherwise, the latter is shown.

For fitted models, either "fit[x]" or "fit[+]" are used where the "x" implies that the model fit failed in some way.

Value

A character value.


parsnip documentation built on June 16, 2022, 5:10 p.m.