Skip to contents

Draft a methods-section paragraph from an LLM run

Source: R/usage.R
llm_methods_text.Rd

Turns the diagnostic columns of a finished run into a first draft of the transparency paragraph that journals and methodological guidelines now ask for: which model(s) and provider(s), how many calls, the inference settings that were recorded, token totals, and the failure/truncation counts. Edit the draft; it states only what the result frame actually contains and marks anything unknown as such.

Usage

llm_methods_text(x, prefix = NULL, task = NULL)

Arguments

x

A data frame from call_llm_par() or llm_mutate().

prefix

For an llm_mutate() result, the output column name whose diagnostics to summarize (e.g. "answer"). Inferred automatically when a single diagnostic block is present; required when several are.

task

Optional one-clause description of what the model was asked to do (e.g., "to code open-ended survey responses into topics"); it is spliced into the first sentence.

Value

A character scalar (one paragraph). Print it with cat().

See also

llm_usage(), llm_log_enable() for the per-call audit trail.

Examples

res <- tibble::tibble(
  model = "openai/gpt-oss-20b", provider = "groq",
  success = c(TRUE, TRUE), finish_reason = c("stop", "stop"),
  sent_tokens = c(10L, 12L), rec_tokens = c(5L, 7L),
  total_tokens = c(15L, 19L), reasoning_tokens = NA_integer_,
  duration = c(0.4, 0.5)
)
cat(llm_methods_text(res, task = "to classify sample sentences"))