highmlr_report: Generate a Quarto/Rmd report skeleton for a highmlr_fit

View source: R/companions.R

highmlr_reportR Documentation

Generate a Quarto/Rmd report skeleton for a highmlr_fit

Description

Writes a self-contained Rmd file that, when rendered, produces a standard biomarker report (selected features, hazard ratios where available, performance, forest plot).

Usage

highmlr_report(fit, file = "highmlr_report.Rmd", render = FALSE)

Arguments

fit

A 'highmlr_fit' object.

file

Output '.Rmd' path (default '"highmlr_report.Rmd"').

render

Logical: if 'TRUE', also render via 'rmarkdown::render()'.

Value

Invisibly, the path to the written file.


highMLR documentation built on May 23, 2026, 5:07 p.m.