type_sum.model_spec: Succinct summary of parsnip object

Description Usage Arguments Details Value

View source: R/type_sum.R

Description

type_sum controls how objects are shown when inside tibble columns.

Usage

1
2
3
4
5
## 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 varying() 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 July 8, 2020, 7:22 p.m.