LongTableDataMapper-accessors {CoreGx}R Documentation

Accessing and modifying data in a LongTableDataMapper object.

Description

Documentation for the various setters and getters which allow manipulation of data in the slots of a LongTableDataMapper object.

Usage

## S4 replacement method for signature 'LongTableDataMapper,list'
rawdata(object) <- value

## S4 method for signature 'LongTableDataMapper'
rowDataMap(object)

## S4 replacement method for signature 'LongTableDataMapper,list_or_List'
rowDataMap(object) <- value

## S4 method for signature 'LongTableDataMapper'
colDataMap(object)

## S4 replacement method for signature 'LongTableDataMapper,list_or_List'
colDataMap(object) <- value

## S4 method for signature 'LongTableDataMapper'
assayMap(object)

## S4 replacement method for signature 'LongTableDataMapper,list_or_List'
assayMap(object) <- value

## S4 method for signature 'LongTableDataMapper'
metadataMap(object)

## S4 replacement method for signature 'LongTableDataMapper,list_or_List'
metadataMap(object) <- value

Arguments

object

A LongTableDataMapper object to get or set data from.

value

See details.

Details

rawdata: Get the raw data slot from a LongTableDataMapper object. Returns a list-like containing one or more raw data inputs to the LongTableDataMapper object.

rawdata: Set the raw data slot from a LongTableDataMapper object. value: The list-like object to set for the rawdata slot. Note: this currently only supports data.frame or data.table objects.

rowDataMap: list of two character vectors, the first are the columns required to uniquely identify each row of a LongTableDataMapper and the second any additional row-level metadata. If the character vectors have names, the resulting columns are automatically renamed to the item name of the specified column.

rowDataMap<-: Update the @rowDataMap slot of a LongTableDataMapper object, returning an invisible NULL. Arguments:

colDataMap: list of two character vectors, the first are the columns required to uniquely identify each row of a LongTableDataMapper and the second any additional col-level metadata. If the character vectors have names, the resulting columns are automatically renamed to the item name of the specified column.

colDataMap<-: Update the @colDataMap slot of a LongTableDataMapper object, returning an invisible NULL. Arguments:

assayMap: A list of character vectors. The name of each list item will be the assay in a LongTableDataMapper object that the columns in the character vector will be assigned to. Column renaming occurs automatically when the character vectors have names (from the value to the name).

assayMap<-: Updates the @assaMap slot of a LongTableDataMapper object, returning an invisible NULL. Arguments:

metadataMap: A list of character vectors. Each item is an element of the constructed objects @metadata slot.

metadataMap<-: Updates LongTableDataMapper object in-place, then returns an invisible(NULL). Arguments:

Value

Accessors: See details

Setters: An update LongTableDataMapper object, returned invisibly.

See Also

Other DataMapper-accessors: DataMapper-accessors

Examples

rowDataMap(exampleDataMapper)

rowDataMap(exampleDataMapper) <- list(c('drug_id'), c())

colDataMap(exampleDataMapper)

colDataMap(exampleDataMapper) <- list(c('cell_id'), c())

assayMap(exampleDataMapper)

assayMap(exampleDataMapper) <- list(sensitivity=c(viability1='viability'))

metadataMap(exampleDataMapper)

metadataMap(exampleDataMapper) <- list(object_metadata=c('metadata'))


[Package CoreGx version 1.5.7 Index]