expTaggedData: expTaggedData Returns a list of names of data items from the...

View source: R/sctkTagging.R

expTaggedDataR Documentation

expTaggedData Returns a list of names of data items from the input SingleCellExperiment object based upon the input parameters.

Description

expTaggedData Returns a list of names of data items from the input SingleCellExperiment object based upon the input parameters.

Usage

expTaggedData(
  inSCE,
  tags = NULL,
  redDims = FALSE,
  recommended = NULL,
  showTags = TRUE
)

Arguments

inSCE

Input SingleCellExperiment object.

tags

A character() value indicating if the data items should be returned separated by the specified tags. Default is NULL indicating that returned names of the data items are simply returned as a list with default tag as "uncategorized".

redDims

A logical value indicating if reducedDims should be returned as well separated with 'redDims' tag.

recommended

A character() vector indicating the tags that should be displayed as recommended. Default is NULL.

showTags

A logical value indicating if the tags should be shown. If FALSE, output is just a simple list, not separated by tags.

Value

A list of names of data items specified by the other parameters.

Examples

data(scExample, package = "singleCellTK")
sce <- expSetDataTag(sce, "raw", "counts")
tags <- expTaggedData(sce)

compbiomed/singleCellTK documentation built on Feb. 10, 2024, 3:32 a.m.