wyz.code.rdoc (version 1.1.19)

generateTable: Generate Table

Description

Generate table format in R documentation

Usage

generateTable(content_dt, alignement_s_1 = NA_character_,
              numberRows_b_1 = FALSE, showHeader_b_1 = TRUE)

Arguments

content_dt

A data.table to be use a source data

alignement_s_1

A single string value, expressing the column alignment directive

numberRows_b_1

A single boolean value. Set it when you want data rows to be automatically numbered.

showHeader_b_1

A single boolean value. Set it when you want column names to be displayed.

Value

A single string, containing potentially many embedded formatting strings.

References

Refer to Writing R extensions section Lists and Tables .

Examples

# NOT RUN {
library(data.table)
dt <- data.table::data.table(x = runif(3), y = letters[1:3])

generateTable(dt)
# "\tabular{ll}{\n0.975343016441911 \tab a \cr\n
#  0.647014946676791 \tab b \cr\n0.576294980244711 \tab c \cr\n}"

generateTable(dt, numberRows_b_1 = TRUE)
# "\tabular{rll}{\n1 \tab 0.11690619844012 \tab a \cr\n
#  2 \tab 0.467709563905373 \tab b \cr\n3 \tab 0.957075224025175 \tab c \cr\n}"
# }