R/print.R

Defines functions print.statlingua_explanation

Documented in print.statlingua_explanation

#' Print LLM explanation
#'
#' Print a formatted version of an LLMs explanation using [cat()].
#'
#' @param x A [statlingua_explanation][explain] object.
#'
#' @param ... Additional optional arguments to be passed to [print.default()].
#'
#' @returns Invisibly returns the printed [statlingua_explanation][explain]
#' object.
#'
#' @export
print.statlingua_explanation <- function(x, ...) {
  cat(x$text, "\n")  # or just cat(x$text) if newlines are already in text
  invisible(x)
}

Try the statlingua package in your browser

Any scripts or data that you put into this service are public.

statlingua documentation built on June 8, 2025, 10:59 a.m.