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

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, ...)

# S3 method for class 'llmr_experiment'
report(x, prefix = NULL, task = NULL, ...)

Arguments

x

An LLMR experiment or 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).

prefix

For an llmr_experiment, the output-column prefix when the object uses llm_mutate() diagnostic names. It is inferred when possible.

task

For an llmr_experiment, an optional clause describing the task, such as "to classify open-ended responses".

Value

A method-defined report object, by convention a character vector with a print method. The llmr_experiment method returns a character scalar containing a draft methods paragraph.

Details

LLMR implements this generic for llmr_experiment objects returned by call_llm_par() and its wrappers. The method packages (LLMRcontent, LLMRpanel) provide methods for their own result classes.

See also

diagnostics(), llm_usage(), llm_log_enable()

Examples

if (FALSE) { # \dontrun{
results <- call_llm_broadcast(cfg, c("First prompt", "Second prompt"))
cat(report(results, task = "to classify short texts"))
} # }