opalr (version 3.3.1)

opal.as_md_table: Array to Markdown

Description

Helper function for turning an array into its Markdown representation.

Usage

opal.as_md_table(
  table,
  icons = TRUE,
  digits = getOption("digits"),
  col.names = colnames(table),
  align,
  caption = NULL
)

Arguments

table

An array, including a matrix or a data.frame.

icons

Turn logicals to icons (requires bootstrap style). Default is TRUE.

digits

The maximum number of digits for numeric columns (passed to round()); it can also be a vector of length ncol(table) to set the number of digits for individual columns.

col.names

A character vector of column names to be used in the table

align

The alignment of columns: a character vector consisting of 'l' (left), 'c' (center) and/or 'r' (right); by default, numeric columns are right-aligned, and other columns are left-aligned; if align = NULL, the default alignment is used.

caption

The table caption.

Examples

if (FALSE) {
o <- opal.login('administrator','password', url='https://opal-demo.obiba.org')
opal.as_md_table(opal.variables(o, 'datashield', 'CNSIM1'))
opal.logout(o)
}