initDGEobj: Initialize with base data (primaryAssayData, row annotations,...

Description Usage Arguments Value Examples

View source: R/init.R

Description

Initialize with base data (primaryAssayData, row annotations, col annotations)

Usage

1
2
3
4
5
6
7
8
9
initDGEobj(
  primaryAssayData,
  rowData,
  colData,
  level,
  customAttr,
  allowShortSampleIDs = FALSE,
  DGEobjDef = initDGEobjDef()
)

Arguments

primaryAssayData

A numeric matrix or dataframe with row and colnames. Each column represents a sample. Each row represents and assay. This is typically the counts matrix in a DGE RNA-Seq experiment.

rowData

Gene, isoform or exon level annotation. Rownames must match the rownames in primaryAssayData

colData

A dataframe describing the experiment design. Rownames much match the colnames(primaryAssayData)

level

One of "gene", "isoform", or "exon"

customAttr

(optional) Named list of attributes

allowShortSampleIDs

Using sequential integer rownames (even if typed as character) is discouraged and by default will abort the DGEobj creation. If you have a legitimate need to have short sample names composed of numeric characters, you can set this argument to TRUE (default = FALSE)

DGEobjDef

An object definition. Defaults to the global DGEobj definition (initDGEobjDef()) and you usually shouldn't change this unless you're customizing the object for new data types.

Value

A DGEobj

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
   dgeObj <- readRDS(system.file("exampleObj.RDS", package = "DGEobj"))
   MyCounts <- dgeObj$counts
   geneinfo <- dgeObj$geneData
   sampinfo <- dgeObj$design

  myDgeObj <- initDGEobj(primaryAssayData = MyCounts,
                         rowData = geneinfo,
                         colData = sampinfo,
                         level = "gene",
                         customAttr = list (Genome = "Rat.B6.0",
                                            GeneModel = "Ensembl.R89"))

DGEobj documentation built on April 10, 2021, 1:07 a.m.