Skip to contents

summary() walks the reader through a symbolized_model in plain English. It opens with one paragraph describing the model in prose (class, family, response, sample size, submodels and links, fitting approach), then prints the same reader tables that explain() returns: equations, the symbol dictionary, assumptions, the formula bridge, the per-coefficient interpretations, and the notation bridge.

Unlike explain(), summary() does not re-run symbolize(); it simply renders the object you already have.

Usage

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

Arguments

object

A symbolized_model.

...

Reserved for future use.

Value

Invisibly returns a summary.symbolized_model object (a list with the rendered pieces). Called for its printed walkthrough.