render: Render a data.frame, risktable, or tableone object as a table

View source: R/render.R

renderR Documentation

Render a data.frame, risktable, or tableone object as a table

Description

[Questioning] Render a previously created data.frame, tibble or tableone object to html, rtf or latex

Usage

render(
  data,
  title = "",
  datasource,
  footnote = "",
  output_format = "html",
  engine = "gt",
  download_format = c("copy", "csv", "excel")
)

Arguments

data

Input data.frame or tibble to visualize

title

Specify the title as a text string to be displayed in the rendered table. Default is no title.

datasource

String specifying the data source underlying the data set. Default is no title.

footnote

String specifying additional information to be displayed as a footnote alongside the data source and specifications of statistical tests.

output_format

Type of output that is returned, can be "html" or "latex". Default is "html".

engine

If "html" is selected as output_format, one can chose between using kable, gt and DT as engine to render the output table. Default is "gt".

download_format

Options formats generated for downloading the data. Default is a list "c('copy', 'csv', 'excel')".

Value

A table data structure with possible interactive functionality depending on the choice of the engine.


visR documentation built on May 29, 2024, 11:50 a.m.