diagnostics: Machine-readable diagnostics for an LLMR-family result object

View source: R/generics.R

diagnosticsR Documentation

Machine-readable diagnostics for an LLMR-family result object

Description

A shared generic across the LLMR method packages. It returns the small, machine-readable set of health numbers behind a result object (the part you would assert in a test or drop into a table), as distinct from report(), which drafts methods-section prose.

Usage

diagnostics(x, ...)

Arguments

x

An object returned by an LLMR method package.

...

Passed to methods.

Details

LLMR defines the generic and an erroring default only. The method packages (LLMRcontent, LLMRpanel) provide the implementations, each returning a tibble of the key numbers for its own result classes.

Value

A method-defined object, by convention a tibble of diagnostic values.

See Also

report()

Examples

## Not run: 
# LLMRcontent, for instance, returns one row of stability and fragility numbers:
diagnostics(audit)

## End(Not run)

LLMR documentation built on July 11, 2026, 1:06 a.m.