report: Draft a methods-section report from an LLMR-family result...

View source: R/generics.R

reportR Documentation

Draft a methods-section report from an LLMR-family result object

Description

A shared generic across the LLMR method packages. It returns the methods-section prose and tables for a result object (what a paper's appendix would print), as distinct from diagnostics(), which returns the machine-readable numbers.

Usage

report(x, ...)

Arguments

x

An object returned by an LLMR method package.

...

Passed to methods (some methods require extra arguments, e.g. some LLMRcontent report methods require the gold set and protocol).

Details

LLMR defines the generic and an erroring default only. The method packages (LLMRcontent, LLMRpanel) provide the implementations.

Value

A method-defined report object, by convention a character vector with a print method.

See Also

diagnostics()

Examples

## Not run: 
# LLMRcontent, for instance, drafts the robustness appendix:
report(audit)

## End(Not run)

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