RadioSet-accessors: Accessing and modifying information in a 'RadioSet'

In bhklab/RadioGx: Analysis of Large-Scale Radio-Genomic Data

Accessing and modifying information in a 'RadioSet'

Description

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

Usage

radiationInfo(...)

radiationInfo(...) <- value

radiationTypes(...)

radiationTypes(...) <- value

## S4 method for signature 'RadioSet'
annotation(object)

## S4 replacement method for signature 'RadioSet,list'
annotation(object) <- value

## S4 method for signature 'RadioSet'
dateCreated(object)

## S4 replacement method for signature 'RadioSet,character'
dateCreated(object) <- value

## S4 method for signature 'RadioSet'
name(object)

## S4 replacement method for signature 'RadioSet'
name(object) <- value

## S4 method for signature 'RadioSet'
sampleInfo(object)

## S4 replacement method for signature 'RadioSet,data.frame'
sampleInfo(object) <- value

## S4 method for signature 'RadioSet'
sampleNames(object)

## S4 replacement method for signature 'RadioSet,character'
sampleNames(object) <- value

## S4 method for signature 'RadioSet'
curation(object)

## S4 replacement method for signature 'RadioSet,list'
curation(object) <- value

## S4 method for signature 'RadioSet'
datasetType(object)

## S4 replacement method for signature 'RadioSet,character'
datasetType(object) <- value

## S4 method for signature 'RadioSet'
molecularProfiles(object, mDataType, assay)

## S4 replacement method for signature 'RadioSet,character,character,matrix'
molecularProfiles(object, mDataType, assay) <- value

## S4 method for signature 'RadioSet'
featureInfo(object, mDataType)

## S4 replacement method for signature 'RadioSet,character,data.frame'
featureInfo(object, mDataType) <- value

## S4 method for signature 'RadioSet,character'
phenoInfo(object, mDataType)

## S4 replacement method for signature 'RadioSet,character,data.frame'
phenoInfo(object, mDataType) <- value

## S4 method for signature 'RadioSet,character'
fNames(object, mDataType)

## S4 replacement method for signature 'RadioSet,character,character'
fNames(object, mDataType) <- value

## S4 method for signature 'RadioSet'
mDataNames(object)

## S4 replacement method for signature 'RadioSet'
mDataNames(object) <- value

## S4 method for signature 'RadioSet'
molecularProfilesSlot(object)

## S4 replacement method for signature 'RadioSet,list_OR_MAE'
molecularProfilesSlot(object) <- value

## S4 method for signature 'RadioSet'
sensitivityInfo(object, dimension, ...)

## S4 replacement method for signature 'RadioSet,data.frame'
sensitivityInfo(object, dimension, ...) <- value

## S4 method for signature 'RadioSet'
sensitivityMeasures(object)

## S4 replacement method for signature 'RadioSet,character'
sensitivityMeasures(object) <- value

## S4 method for signature 'RadioSet'
sensitivityProfiles(object)

## S4 replacement method for signature 'RadioSet,data.frame'
sensitivityProfiles(object) <- value

## S4 method for signature 'RadioSet'
sensitivityRaw(object)

## S4 replacement method for signature 'RadioSet,array'
sensitivityRaw(object) <- value

## S4 method for signature 'RadioSet'
treatmentResponse(object)

## S4 replacement method for signature 'RadioSet,list_OR_LongTable'
treatmentResponse(object) <- value

## S4 method for signature 'RadioSet'
sensNumber(object)

## S4 replacement method for signature 'RadioSet,matrix'
sensNumber(object) <- value

## S4 method for signature 'RadioSet'
pertNumber(object)

## S4 replacement method for signature 'RadioSet,array'
pertNumber(object) <- value

Arguments

...	See details.
value	See details.
object	A 'RadioSet' object.
mDataType	'character(1)' The name of a molecular datatype to access from the 'molecularProfiles' of a 'RadioSet' object.
assay	'character(1)' A valid assay name in the 'SummarizedExperiment' of '@molecularProfiles' of a RadioSet object for data type 'mDataType'.
dimension	See details.

Details

treatmentInfo: data.frame Metadata for all treatments in a RadioSet object. Arguments:

• object: RadioSet An object to retrieve treatment metadata from.

treatmentInfo<-: RadioSet object with updated treatment metadata. object. Arguments:

• object: RadioSet An object to set treatment metadata for.

• value: data.frame A new table of treatment metadata for object.

treatmentNames: character Names for all treatments in a RadioSet object. Arguments:

• object: RadioSet An object to retrieve treatment names from.

treatmentNames<-: RadioSet Object with updates treatment names. object. Arguments:

• object: RadioSet An object to set treatment names from.

• value: character A character vector of updated treatment names.

@annotation

annotation: A list of RadioSet annotations with items: 'name', the name of the object; 'dateCreated', date the object was created; 'sessionInfo', the sessionInfo() when the object was created; 'call', the R constructor call; and 'version', the object version.

annotation<-: Setter method for the annotation slot. Arguments:

• value: a list of annotations to update the RadioSet with.

@dateCreated

dateCreated: character(1) The date the RadioSet object was created, as returned by the date() function.

dateCreated<-: Update the 'dateCreated' item in the annotation slot of a RadioSet object. Arguments:

• value: A character(1) vector, as returned by the date() function.

name: character(1) The name of the RadioSet, retreived from the ⁠@annotation⁠ slot.

name<-: Update the ⁠@annotation$name⁠ value in a RadioSet object.

• value: character(1) The name of the RadioSet object.

cellInfo: data.frame Metadata for all sample in a RadioSet object.

sampleInfo<-: assign updated sample annotations to the RadioSet object. Arguments:

• value: a data.frame object.

sampleNames: character Retrieve the rownames of the data.frame in the sample slot from a RadioSet object.

sampleNames<-: assign new rownames to the sampleInfo data.frame for a RadioSet object. Arguments:

• value: character vector of rownames for the sampleInfo(object) data.frame.

@curation

curation: A list of curated mappings between identifiers in the RadioSet object and the original data publication. Contains three data.frames, 'cell' with cell-line ids and 'tissue' with tissue ids and 'radiation' with radiation ids.

curation<-: Update the curation slot of a RadioSet object. Arugments:

• value: A list of data.frames, one for each type of curated identifier. For a RadioSet object the slot should contain tissue, cell-line and radiation id data.frames.

datasetType slot

datasetType: character(1) The type treatment response in the sensitivity slot. Valid values are 'sensitivity', 'perturbation' or 'both'.

datasetType<-: Update the datasetType slot of a RadioSet object. Arguments:

• value: A character(1) vector with one of 'sensitivity', 'perturbation' or 'both'

@molecularProfiles

molecularProfiles: matrix() Retrieve an assay in a SummarizedExperiment from the molecularProfiles slot of a RadioSet object with the specified mDataType. Valid mDataType arguments can be found with mDataNames(object). Exclude mDataType and assay to access the entire slot. Arguments:

• assay: Optional character(1) vector specifying an assay in the SummarizedExperiment of the molecularProfiles slot of the RadioSet object for the specified mDataType. If excluded, defaults to modifying the first assay in the SummarizedExperiment for the given mDataType.

molecularProfiles<-: Update an assay in a SummarizedExperiment from the molecularProfiles slot of a RadioSet object with the specified mDataType. Valid mDataType arguments can be found with mDataNames(object). Omit mDataType and assay to update the slot.

• assay: Optional character(1) vector specifying an assay in the SummarizedExperiment of the molecularProfiles slot of the RadioSet object for the specified mDataType. If excluded, defaults to modifying the first assay in the SummarizedExperiment for the given mDataType.

• value: A matrix of values to assign to the assay slot of the SummarizedExperiment for the selected mDataType. The rownames and column names must match the associated SummarizedExperiment.

featureInfo: Retrieve a DataFrame of feature metadata for the specified mDataType from the molecularProfiles slot of a RadioSet object. More specifically, retrieve the ⁠@rowData⁠ slot from the SummarizedExperiment from the ⁠@molecularProfiles⁠ of a RadioSet object with the name mDataType.

__featureInfo<-__: Update the 'featureInfo(object, mDataType)' 'DataFrame' with new feature metadata. Arguments: - value: A 'data.frame' or 'DataFrame' with updated feature metadata for the specified molecular profile in the 'molecularProfiles' slot of a 'RadioSet' object.

phenoInfo: Return the ⁠@colData⁠ slot from the SummarizedExperiment of mDataType, containing sample-level metadata, from a RadioSet object.

phenoInfo<-: Update the ⁠@colData⁠ slot of the SummarizedExperiment of mDataType in the ⁠@molecularProfiles⁠ slot of a RadioSet object. This updates the sample-level metadata in-place.

• value: A data.frame or DataFrame object where rows are samples and columns are sample metadata.

fNames: character() The features names from the rowData slot of a SummarizedExperiment of mDataType within a RadioSet object.

fNames: Updates the rownames of the feature metadata (i.e., rowData) for a SummarizedExperiment of mDataType within a RadioSet object.

• value: character() A character vector of new features names for the rowData of the SummarizedExperiment of mDataType in the ⁠@molecularProfiles⁠ slot of a RadioSet object. Must be the same length as nrow(featureInfo(object, mDataType)), the number of rows in the feature metadata.

mDataNames: character Retrieve the names of the molecular data types available in the molecularProfiles slot of a RadioSet object. These are the options which can be used in the mDataType parameter of various molecularProfiles slot accessors methods.

mDataNames: Update the molecular data type names of the molecularProfiles slot of a RadioSet object. Arguments:

• value: character vector of molecular datatype names, with length equal to length(molecularProfilesSlot(object)).

molecularProfilesSlot: Return the contents of the ⁠@molecularProfiles⁠ slot of a RadioSet object. This will either be a list or MultiAssayExperiment of SummarizedExperiments.

molecularProfilesSlot<-: Update the contents of the ⁠@molecularProfiles⁠ slot of a RadioSet object. Arguemnts:

• value: A list or MultiAssayExperiment of SummarizedExperiments. The list and assays should be named for the molecular datatype in each SummarizedExperiment.

@treatmentResponse

Arguments:

• dimension: Optional character(1) One of 'treatment', 'sample' or 'assay' to retrieve rowData, colData or the 'assay_metadata' assay from the RadioSet ⁠@sensitvity⁠ LongTable object, respectively. Ignored with warning if ⁠@treatmentResponse⁠ is not a LongTable object.

• ...: Additional arguments to the rowData or colData. LongTable methods. Only used if the sensitivity slot contains a LongTable object instead of a list and the dimension argument is specified.

Methods:

sensitivityInfo: DataFrame or data.frame of sensitivity treatment combo by sample metadata for the RadioSet object. When the dimension parameter is used, it allows retrieval of the dimension specific metadata from the LongTable object in ⁠@treatmentResponse⁠ of a RadioSet object.

sensitivityInfo<-: Update the ⁠@treatmentResponse⁠ slot metadata for a RadioSet object. When used without the dimension argument is behaves similar to the old RadioSet implementation, where the ⁠@treatmentResponse⁠ slot contained a list with a ⁠$info⁠ data.frame item. When the dimension arugment is used, more complicated assignments can occur where 'sample' modifies the ⁠@sensitvity⁠ LongTable colData, 'treatment' the rowData and 'assay' the 'assay_metadata' assay. Arguments:

• value: A data.frame of treatment response experiment metadata, documenting experiment level metadata (mapping to treatments and samples). If the ⁠@treatmentResponse⁠ slot doesn't contain a LongTable and dimension is not specified, you can only modify existing columns as returned by sensitivityInfo(object).

sensitivityMeaures: Get the 'sensitivityMeasures' available in a RadioSet object. Each measure reprents some summary of sample sensitivity to a given treatment, such as ic50, ec50, AUC, AAC, etc. The results are returned as a character vector with all available metrics for the PSet object.

sensitivityMeaures: Update the sensitivity meaure in a RadioSet object. Thesee values are the column names of the 'profiles' assay and represent various compued sensitviity metrics such as ic50, ec50, AUC, AAC, etc.

• value: A character vector of new sensitivity measure names, the then length of the character vector must matcht he number of columns of the 'profiles' assay, excluding metadata and key columns.

sensitivityProfiles: Return the sensitivity profile summaries from the sensitivity slot. This data.frame cotanins vaarious sensitivity summary metrics, such as ic50, amax, EC50, aac, HS, etc as columns, with rows as treatment by sample experiments.

sensitivityProfiles<-: Update the sensitivity profile summaries the sensitivity slot. Arguments: -value: A data.frame the the same number of rows as as returned by sensitivityProfiles(object), but potentially modified columns, such as the computation of additional summary metrics.

sensitivityRaw: Access the raw sensitiity measurents for a RadioSet object. A 3D array where rows are experiment_ids, columns are doses and the third dimension is metric, either 'Dose' for the doses used or 'Viability' for the sample viability at that dose.

sensitvityRaw<-: Update the raw dose and viability data in a RadioSet.

• value: A 3D array object where rows are experiment_ids, columns are replicates and pages are c('Dose', 'Viability'), with the corresponding dose or viability measurement for that experiment_id and replicate.

sensNumber: Return a count of viability observations in a RadioSet object for each treatment-combo by sample combination.

sensNumber<-: Update the 'n' item, which holds a matrix with a count of treatment by sample-line experiment counts, in the list in ⁠@treatmentResponse⁠ slot of a RadioSet object. Will error when ⁠@sensitviity⁠ contains a LongTable object, since the counts are computed on the fly. Arguments:

• value: A matrix where rows are samples and columns are treatments, with a count of the number of experiments for each combination as the values.

pertNumber: array Summary of available perturbation experiments from in a RadioSet object. Returns a 3D array with the number of perturbation experiments per treatment and sample, and data type.

pertNumber<-: Update the ⁠@perturbation$n⁠ value in a RadioSet object, which stores a summary of the available perturbation experiments. Arguments:

• value: A new 3D array with the number of perturbation experiments per treatment and sample, and data type

Value

Accessors: See details.

Setters: An updated 'RadioSet' object, returned invisibly.

Examples

data(clevelandSmall)
treatmentInfo(clevelandSmall)

treatmentInfo(clevelandSmall) <- treatmentInfo(clevelandSmall)

treatmentNames(clevelandSmall)

treatmentNames(clevelandSmall) <- treatmentNames(clevelandSmall)


## @annotation

annotation(clevelandSmall)

annotation(clevelandSmall) <- annotation(clevelandSmall)

dateCreated(clevelandSmall)

## dateCreated
dateCreated(clevelandSmall) <- date()

name(clevelandSmall)

name(clevelandSmall) <- 'new_name'

sampleInfo(clevelandSmall) <- sampleInfo(clevelandSmall)

sampleNames(clevelandSmall)

sampleNames(clevelandSmall) <- sampleNames(clevelandSmall)

## curation
curation(clevelandSmall)

curation(clevelandSmall) <- curation(clevelandSmall)

datasetType(clevelandSmall)

datasetType(clevelandSmall) <- 'both'

# No assay specified
molecularProfiles(clevelandSmall, 'rna') <- molecularProfiles(clevelandSmall, 'rna')

# Specific assay
molecularProfiles(clevelandSmall, 'rna', 'exprs') <-
    molecularProfiles(clevelandSmall, 'rna', 'exprs')

# Replace the whole slot
molecularProfiles(clevelandSmall) <- molecularProfiles(clevelandSmall)

featureInfo(clevelandSmall, 'rna')

featureInfo(clevelandSmall, 'rna') <- featureInfo(clevelandSmall, 'rna')

phenoInfo(clevelandSmall, 'rna')

phenoInfo(clevelandSmall, 'rna') <- phenoInfo(clevelandSmall, 'rna')

fNames(clevelandSmall, 'rna')

fNames(clevelandSmall, 'rna') <- fNames(clevelandSmall, 'rna')

mDataNames(clevelandSmall)

mDataNames(clevelandSmall) <- mDataNames(clevelandSmall)

molecularProfilesSlot(clevelandSmall)

molecularProfilesSlot(clevelandSmall) <- molecularProfilesSlot(clevelandSmall)

sensitivityInfo(clevelandSmall)

sensitivityInfo(clevelandSmall) <- sensitivityInfo(clevelandSmall)

sensitivityMeasures(clevelandSmall) <- sensitivityMeasures(clevelandSmall)

sensitivityMeasures(clevelandSmall) <- sensitivityMeasures(clevelandSmall)

sensitivityProfiles(clevelandSmall)

sensitivityProfiles(clevelandSmall) <- sensitivityProfiles(clevelandSmall)

head(sensitivityRaw(clevelandSmall))

sensitivityRaw(clevelandSmall) <- sensitivityRaw(clevelandSmall)

treatmentResponse(clevelandSmall)

treatmentResponse(clevelandSmall) <- treatmentResponse(clevelandSmall)

sensNumber(clevelandSmall)

sensNumber(clevelandSmall) <- sensNumber(clevelandSmall)

pertNumber(clevelandSmall)

pertNumber(clevelandSmall) <- pertNumber(clevelandSmall)

bhklab/RadioGx documentation built on Oct. 6, 2023, 8:27 a.m.