Skip to contents

Provides a comprehensive summary of a `discourse.object`, including RMSE, model components, and statistics depending on the analysis type (LM/LME, ANOVA, or vec).

Usage

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

Arguments

object

A `discourse.object` produced by `optim_*` functions.

...

Additional arguments (unused).

Value

An object of class `summary.discourse.object` containing:

rmse

Named list of RMSE values.

inputs

Original input list.

data

Optimized data frame.

best_error

Numeric. Minimum objective error achieved.

track_error

Numeric vector of best error at each iteration.

track_error_ratio

Numeric vector of error ratios (cor vs. reg) per iteration (if available).

model

Fitted regression model or ANOVA table (if applicable).

coefficients

regression estimates (LM/LME only).

std_errors

Coefficient standard errors (LM/LME only).

correlations

Correlation values (LM/LME only).

F_value

ANOVA F statistics (ANOVA only).

means

Group or variable means.

sds

Group or variable standard deviations (vector only).

Examples

 if (FALSE) { # \dontrun{
res_lm <- optim_lm(args = ..., ...)
summary(res_lm)
} # }