to_latex: Convert result table into basic kable LaTeX-table.

Description Usage Arguments Value

View source: R/to_result_table.R

Description

Used to generate a basic result table object based on results of to_result_table.

Usage

1
2
to_latex(tbl, param.col.names, measure.col.names, reps = 1L, algo.names,
  algo.colors = NULL, caption = "Placeholder", longtable = FALSE)

Arguments

tbl

[|codedata.frame]
Input data frame (usually result of to_result_table).

param.col.names

[character]
Names of parameter columns used for table header. Parameter column names are supposed to be the first k column in tbl.

measure.col.names

[character]
Names of measurement columns. These are repeated for each algorithm (see algo.names).

reps

[integer(1)]
How often should measurement columns be repeated? Defaults to 1. This is useful if results for multiple performance measures should be displayed side by side in the same table.

algo.names

[character]
Names of algorithms. Used to group measurement columns. Note that algorithms are numbered by their index.

algo.colors

[character]
Vector of color names used to color-code algorithms for better visual interpretation.

caption

[character(1)]
LaTeX-table caption.

longtable

[|codelogical(1)]
Should the table be used in a longtable environment? Default is FALSE.

Value

[character(1)] A character vector of the table source code.


jakobbossek/tblutils documentation built on March 13, 2021, 12:47 p.m.