build_report: Build HTML report

View source: R/report.R

build_reportR Documentation

Build HTML report

Description

Build an HTML report with all the results from the chosen clinical endpoint

Usage

build_report(
  endpoint = c("VO2max", "Flow-mediated Dilation", "BMI", "Body Mass", "Body Fat",
    "Systolic Blood Pressure", "Diastolic Blood Pressure", "HDL", "LDL", "Triglycerides",
    "Total Cholesterol", "C-reactive Protein", "Fasting Insulin", "Fasting Glucose",
    "HbA1c", "HOMA-IR"),
  path,
  format = ".html"
)

Arguments

endpoint

The clinical endpoint to build the HTML report.

path

Path to write to. It has to be a character string indicating the path and file name (without the extension). For example, ⁠~/Documents/metabolic_report⁠ will save metabolic_report.html to the Documents folder.

format

The file extension that you want to build the report with. Only .html, is supported.

Value

an HTML file.

Examples

if(interactive()) {
# Build an HTML report on VO2max
build_report(endpoint = "VO2max", path = tempfile())
}

metabolic documentation built on Oct. 10, 2023, 9:06 a.m.