TableContainer {TableContainer}R Documentation

The constructor function for TableContainer

Description

Creates a TableContainer object with the specified matrix, rowData, colData, and metadata.

Usage

TableContainer(table = NULL, rowData = NULL, colData = NULL, metaData = NULL)

Arguments

table

A matrix, data.frame, or NULL.

rowData

A data.frame or NULL object describing the rows.

colData

A data.frame or NULL object describing the columns.

metaData

A list or NULL containing arbitrary metadata associated with the overall data.

Value

A TableContainer object.

Examples

tbl <- matrix(1:12, nrow = 3, ncol = 4)
row_dt <- data.frame(row1 = 1:3, row2 = letters[1:3])
col_dt <- data.frame(col1 = 1:4, col2 = letters[1:4])
meta_dt <- list(meta1 = "meta1", meta2 = "meta2")

TableContainer(
    table = tbl,
    rowData = row_dt,
    colData = col_dt,
    metaData = meta_dt
)


[Package TableContainer version 1.0.0 Index]