statlingua (version 0.1.0)

summarize: Summarize statistical output

Description

Generate text-based summaries of statistical output that can be embedded into prompts for querying Large Language Models (LLMs). Intended primarily for internal use.

Usage

summarize(object, ...)
# S3 method for default
summarize(object, ...)
# S3 method for htest
summarize(object, ...)
# S3 method for lm
summarize(object, ...)
# S3 method for glm
summarize(object, ...)
# S3 method for polr
summarize(object, ...)
# S3 method for lme
summarize(object, ...)
# S3 method for lmerMod
summarize(object, ...)
# S3 method for glmerMod
summarize(object, ...)
# S3 method for gam
summarize(object, ...)
# S3 method for survreg
summarize(object, ...)
# S3 method for coxph
summarize(object, ...)
# S3 method for rpart
summarize(object, ...)

Value

A character string summarizing the statistical output.

Arguments

object

An object for which a summary is desired (e.g., a glm object).

...

Additional optional arguments. (Currently ignored.)

See Also

summary().

Examples

tt <- t.test(1:10, y = c(7:20))
summarize(tt)  # prints output as a character string
cat(summarize(tt))  # more useful for reading