Skip to contents

Machine-readable diagnostics for an LLMR-family result object

Source: R/generics.R
diagnostics.Rd

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.

Value

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

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.

See also

report()

Examples

if (FALSE) { # \dontrun{
# LLMRcontent, for instance, returns one row of stability and fragility numbers:
diagnostics(audit)
} # }