to_markdown: Render a report as Markdown

to_markdownR Documentation

Render a report as Markdown

Description

Render a writeup, review or AI review as Markdown, the text write_text writes to a file and rtemislive displays. Top-level sections are ⁠##⁠ headings, so the text can be placed under a title of the reader's choosing.

Usage

to_markdown(x, ...)

Arguments

x

SupervisedWriteup, SupervisedReview or AISupervisedReview object.

...

Not used.

Value

Character scalar ending in a newline.

Author(s)

EDG

Examples

idx <- c(1:40, 51:90, 101:140)
mod <- train(
  iris[idx, ],
  dat_test = iris[-idx, ],
  hyperparameters = setup_CART(),
  verbosity = 0L
)
cat(to_markdown(review(mod)))

rtemis documentation built on Oct. 20, 2026, 1:06 a.m.