html5.tangram: Convert a tangram class into an HTML5 string

View source: R/render-html5.R

html5.tangramR Documentation

Convert a tangram class into an HTML5 string

Description

Given a tangram class, a series of conversion creates an HTML5 representation of the table. It may be an HTML5 fragment or it may be a complete web page.

Usage

## S3 method for class 'tangram'
html5(
  object,
  id = NULL,
  caption = NULL,
  fragment = NULL,
  style = NULL,
  footnote = NULL,
  inline = NULL,
  fixed_thead = NULL,
  ...
)

Arguments

object

The cell table to render to HTML5

id

A unique identifier for the table (strongly recommended). If not provided, caption will be used.

caption

A string caption for the table

fragment

A boolean flag that determines whether a fragment or a complete HTML5 document is generatedf

style

A string containing a style filename to include as inline CSS. It first searches the drive for the file, if that fails it looks inside the package for a matching css file.

footnote

Any footnotes to include under the table.

inline

DEPRECATED

fixed_thead

logical; fixes the header using position sticky in CSS defaults to FALSE

...

additional arguments to renderer. Unused

Details

The package includes several css files for styling. At present the following exist: 'hmisc.css', 'lancet.css', 'lancet-stripped.css' and 'nejm.css'

Value

A text string rendering of the given table in HTML5


spgarbet/tg documentation built on Feb. 21, 2023, 3:35 a.m.