RCGenericTable-class: Reference class representing a generic table

Description Details Fields Methods

Description

Within the reference object of reference class RCGenericTable a table is represented by a header and a body. Tables can only be modified by adding new rows. The two methods to_knitr_kable and to_pander_pandoc write tables in markdown format using functions knitr::kable() and pander::pandoc.table()

Details

A reference object of reference class RCGenericTable assumes that a table simply consists of a header and a body. The body is just a character vector where each component represents one column header. The body is a list which each element contains the data for one column. The reference class components are represented by the fields sTableHeader and lTableBody. The initialisation method creates a table with an empty body. The table header field has a getter and a setter methods. The method addRow adds a new row at the end of the table.

Fields

sTableHeader

vector of table headers

lTableBody

list of table body

Methods

addRow(plTableRow)

Adding a row represented by a list to the body of the table. The list representing the row must have the same names as the existing table body, otherwise, the row is not added to the table body.

getTableHeader()

Getter for table header

initialize()

Initialisation of table with empty body.

setTableHeader(psTableHeader)

Setter for table header

to_knitr_kable()

Output current table in markdown format using function knitr::kable(). In case the length of the specified table header is consistent with the number of columns, then the table header is added as columnnames of the data.frame representation of the table body.

to_pander_pandoc(psStyle = "rmarkdown", psJustify = NULL, pnSplitCells = 30)

Output current table in markdown format using the function pander::pandoc.table(). This method accepts two parameters psStyle and psJustify which are passed to to pander::pandoc.table().


charlotte-ngs/rcoursetools documentation built on May 13, 2019, 3:34 p.m.