summary-methods: Model summaries

summaryR Documentation

Model summaries

Description

summary produces model summaries.

Usage

summary(object, ...)

## S4 method for signature 'familiarModel'
summary(object, ...)

Arguments

object

a familiarModel object

...

additional arguments passed to summary methods for the underlying model, when available.

Details

This method extends the summary S3 method. For some models summary requires information that is trimmed from the model. In this case a copy of summary data is stored with the model, and returned.

Value

Depends on underlying model. See the documentation for the particular models.


familiar documentation built on Sept. 30, 2024, 9:18 a.m.