Skip to contents

Returns a draft Methods-section paragraph for a fitted model — the kind of paragraph a biologist would otherwise have to write by hand into a paper. The prose is composed from CSV templates — the paragraph frame from (inst/extdata/methods-templates.csv) and the reusable clause phrases from (inst/extdata/methods-phrases.csv) — using slots filled from the symbolized_model. No prose is generated by a language model at runtime; every phrase traces to a template row plus the substituted slots.

The output is always a draft. Treat it as starting material to be edited: confirm the package version, soften or sharpen the sentences, add the citation, and drop in any study-specific context. The print method appends an editorial reminder for that reason.

Usage

methods_text(sym, ...)

Arguments

sym

A symbolized_model.

...

Reserved for future use.

Value

A list classed c("symbolizer_methods_text", "list") with slots text (the assembled paragraph as a single character string), slots (the named substitutions used), and reminders (character vector of editorial reminders for the author).

Examples

if (FALSE) { # \dontrun{
fit <- drmTMB::drmTMB(
  drmTMB::drm_formula(body_mass ~ temperature, sigma ~ temperature),
  family = stats::gaussian(), data = body_mass_dat
)
sym <- symbolize(fit)
methods_text(sym)
} # }