1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/MultiAssayExperiment-class.R,
% R/MultiAssayExperiment-methods.R
\name{MultiAssayExperiment-methods}
\alias{MultiAssayExperiment-methods}
\alias{experiments}
\alias{sampleMap}
\alias{experiments<-}
\alias{sampleMap<-}
\alias{sampleMap,MultiAssayExperiment-method}
\alias{experiments,MultiAssayExperiment-method}
\alias{colData,MultiAssayExperiment-method}
\alias{metadata,MultiAssayExperiment-method}
\alias{sampleMap<-,MultiAssayExperiment,DataFrame-method}
\alias{sampleMap<-,MultiAssayExperiment,ANY-method}
\alias{experiments<-,MultiAssayExperiment,ExperimentList-method}
\alias{colData<-,MultiAssayExperiment,DataFrame-method}
\alias{colData<-,MultiAssayExperiment,ANY-method}
\alias{metadata<-,MultiAssayExperiment-method}
\alias{$<-,MultiAssayExperiment-method}
\alias{names<-,MultiAssayExperiment-method}
\alias{$,MultiAssayExperiment-method}
\title{Accessing and modifying information in MultiAssayExperiment}
\usage{
\S4method{sampleMap}{MultiAssayExperiment}(x)
\S4method{experiments}{MultiAssayExperiment}(x)
\S4method{colData}{MultiAssayExperiment}(x, ...)
\S4method{metadata}{MultiAssayExperiment}(x)
\S4method{sampleMap}{MultiAssayExperiment,DataFrame}(object) <- value
\S4method{sampleMap}{MultiAssayExperiment,ANY}(object) <- value
\S4method{experiments}{MultiAssayExperiment,ExperimentList}(object) <- value
\S4method{colData}{MultiAssayExperiment,DataFrame}(x) <- value
\S4method{colData}{MultiAssayExperiment,ANY}(x) <- value
\S4method{metadata}{MultiAssayExperiment}(x, ...) <- value
\S4method{$}{MultiAssayExperiment}(x, name) <- value
\S4method{names}{MultiAssayExperiment}(x) <- value
\S4method{$}{MultiAssayExperiment}(x, name)
}
\arguments{
\item{...}{Argument not in use}
\item{object, x}{A \code{MultiAssayExperiment} object}
\item{value}{See details.}
\item{name}{A column in \code{colData}}
}
\value{
Accessors: Either a \code{sampleMap}, \code{ExperimentList}, or
\code{DataFrame} object
Setters: A \code{MultiAssayExperiment} object
}
\description{
A set of accessor and setter generic functions to extract
either the \code{sampleMap}, the \code{\link{ExperimentList}},
\code{colData}, or \code{metadata} slots of a
\code{\link{MultiAssayExperiment}} object
}
\section{Accessors}{
Eponymous names for accessing \code{MultiAssayExperiment} slots with the
exception of the \link{ExperimentList} accessor named \code{experiments}.
\itemize{
\item colData: Access the \code{colData} slot
\item sampleMap: Access the \code{sampleMap} slot
\item experiments: Access the \link{ExperimentList} slot
\item `[[`: Access the \link{ExperimentList} slot
\item `$`: Access a column in \code{colData}
}
}
\section{Setters}{
Setter method values (i.e., '\code{function(x) <- value}'):
\itemize{
\item experiments<-: An \code{\link{ExperimentList}} object
containing experiment data of supported classes
\item sampleMap<-: A \code{\link{DataFrame}} object relating
samples to biological units and assays
\item colData<-: A \code{\link{DataFrame}} object describing the
biological units
\item metadata<-: A \code{list} object of metadata
\item `[[<-`: Equivalent to the \code{experiments<-} setter method for
convenience
\item `$<-`: A vector to replace the indicated column in \code{colData}
}
}
\examples{
## Load example MultiAssayExperiment
example(MultiAssayExperiment)
## Access the sampleMap
sampleMap(mae)
## Replacement method for a MultiAssayExperiment sampleMap
sampleMap(mae) <- S4Vectors::DataFrame()
## Access the ExperimentList
experiments(mae)
## Replace with an empty ExperimentList
experiments(mae) <- ExperimentList()
## Access the metadata
metadata(mae)
## Replace metadata with a list
metadata(mae) <- list(runDate =
format(Sys.time(), "\%B \%d, \%Y"))
## Access the colData
colData(mae)
## Access a column in colData
mae$age
## Replace a column in colData
mae$age <- mae$age + 1
}
|