add_se: Method to add a 'SummarizedExperiment' to 'MultiDataSet'.

Description Usage Arguments Value Examples

Description

This method adds or overwrites a slot of a MultiDataSet with the content of the given SummarizedExperiment.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
add_se(
  object,
  set,
  dataset.type,
  dataset.name = NULL,
  sample.tables = NULL,
  feature.tables = NULL,
  warnings = TRUE,
  overwrite = FALSE,
  GRanges
)

Arguments

object

MultiDataSet that will be filled.

set

Object derived from SummarizedExperiment to be used to fill the slot.

dataset.type

Character with the type of data of the omic set (e.g. expression, methylation...)

dataset.name

Character with the specific name for this set (NULL by default). It is useful when there are several sets of the same type (e.g. multiple expression assays)

sample.tables

Character with the names of the slots with sample data besides colData.

feature.tables

Character with the names of the slots with feature data besides rowData.

warnings

Logical to indicate if warnings will be displayed.

overwrite

Logical to indicate if the set stored in the slot will be overwritten.

GRanges

GenomicRanges to be included in rowRanges slot.

Value

A new MultiDataSet with a slot filled.

Examples

1
2
3
multi <- createMultiDataSet()
se <- SummarizedExperiment::SummarizedExperiment(matrix(runif(10), 5))
multi <- add_se(multi, se, "exampledata", GRanges = NA)

isglobal-brge/MultiDataSet documentation built on Oct. 9, 2021, 11:42 a.m.