File: SE2DGEList.Rd

package info (click to toggle)
r-bioc-edger 3.40.2%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,484 kB
  • sloc: cpp: 1,425; ansic: 1,109; sh: 21; makefile: 5
file content (36 lines) | stat: -rw-r--r-- 1,098 bytes parent folder | download | duplicates (3)
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
\name{SE2DGEList}
\alias{SE2DGEList}

\title{SummarizedExperiment to DGEList}

\description{Given any \code{SummarizedExperiment} data object, extract basic information needed and convert it into a \code{DGEList} object.}

\usage{
SE2DGEList(object)
}

\arguments{
\item{object}{a \code{SummarizedExperiment} object. Must have \code{counts} in its assay component.}
}

\details{
This function takes a \code{SummarizedExperiment} data object as input.
The \code{counts} of the assay component of the input \code{SummarizedExperiment} data object is extracted and used as the \code{counts} component of the output \code{DGEList} object.
The \code{rowRanges} or \code{rowData} of the input is converted into a \code{data.frame} and used as \code{genes} in the output.
The \code{colData} of the input is also converted into a \code{data.frame} and used as the sample information in the output.
}

\value{
A \code{DGEList} object.
}

\author{Yunshun Chen and Gordon Smyth}

\examples{
\dontrun{
library(SummarizedExperiment)
example(SummarizedExperiment)
y <- SE2DGEList(se)
}}

\concept{edgeR classes}