LongTable: LongTable constructor method

In bhklab/CoreGx: Classes and Functions to Serve as the Basis for Other 'Gx' Packages

LongTable constructor method

Description

LongTable constructor method

Usage

LongTable(
  rowData,
  rowIDs,
  colData,
  colIDs,
  assays,
  assayIDs,
  metadata = list(),
  keep.rownames = FALSE
)

Arguments

rowData	data.frame A rectangular object coercible to a data.table.
rowIDs	character A vector of rowData column names needed to uniquely identify each row in a LongTable.
colData	data.frame A rectangular object coercible to a data.table.
colIDs	chacter A vector of colData column names needed to uniquely identify each column in a LongTable.
assays	list A list of rectangular objects, each coercible to a data.table. Must be named and item names must match the assayIDs list.
assayIDs	list A list of character vectors specifying the columns needed to uniquely identify each row in an assay. Names must match the assays list.
metadata	list A list of one or more metadata items associated with a LongTable experiment.
keep.rownames	logical(1) or character(1) Should rownames be retained when coercing to data.table inside the constructor. Default is FALSE. If TRUE, adds a 'rn' column to each rectangular object that gets coerced from data.frame to data.table. If a string, that becomes the name of the rownames column.

Value

A LongTable object containing the data for a treatment response experiment and configured according to the rowIDs and colIDs arguments.

Examples

"See vignette('The LongTable Class', package='CoreGx')"

bhklab/CoreGx documentation built on March 14, 2024, 3:04 a.m.