man/combine.Rd
af6d4d8a
 % Generated by roxygen2: do not edit by hand
4574c875
 % Please edit documentation in R/qtle_combine.R
af6d4d8a
 \docType{methods}
4574c875
 \name{QTLe-combine}
 \alias{QTLe-combine}
 \alias{cbind,QTLExperiment-method}
 \alias{rbind,QTLExperiment-method}
 \title{Combining QTLExperiment objects}
4fddca3d
 \value{
 A \linkS4class{QTLExperiment} object.
 }
af6d4d8a
 \description{
fe1e4505
 An overview of methods to combine multiple
4574c875
 \linkS4class{QTLExperiment} objects by row or column.
fe1e4505
 These methods ensure that all data fields remain synchronized when states
 or associations are added or removed.
af6d4d8a
 }
 \section{Combining}{
 
fe1e4505
 In the following examples, \code{...} contains one or more
4574c875
 \linkS4class{QTLExperiment} object.
af6d4d8a
 \describe{
fe1e4505
 \item{\code{rbind(..., deparse.level=1)}:}{Returns a
4574c875
 \linkS4class{QTLExperiment} object where all objects are combined
 row-wise. Metadata is combined as in
aeee5fea
 \code{?"\link[SummarizedExperiment]{rbind,SummarizedExperiment-method}"}. The \code{deparse.level}
fe1e4505
 specifies how row.names are generated as described in
 \code{?\link[base]{rbind}}.
 }
 
 \item{\code{cbind(..., deparse.level=1)}:}{Returns a
4574c875
 \linkS4class{QTLExperiment} object where all objects are combined
 column-wise. Metadata is combined
aeee5fea
 as in \code{?"\link[SummarizedExperiment]{cbind,SummarizedExperiment-method}"}. The
fe1e4505
 \code{deparse.level} specifies how colnames are generated as described in
 \code{?\link[base]{cbind}}.
af6d4d8a
 }
 }
 }
 
 \examples{
4574c875
 qtle <- mockQTLE()
 qtle2 <- qtle
 feature_id(qtle2) <- paste0("x", feature_id(qtle2))
 rbind(qtle, qtle2)
 
 qtle2 <- qtle
 state_id(qtle2) <- paste0("x", state_id(qtle2))
 cbind(qtle, qtle2)
af6d4d8a
 
 
 }
 \author{
 Christina B Azodi
 }