gene {dittoSeq} | R Documentation

## Returns the expression values of a gene for all cells/samples

### Description

Returns the expression values of a gene for all cells/samples

### Usage

    gene(
      gene,
      object,
      assay = .default_assay(object),
      slot = .default_slot(object),
      adjustment = NULL,
      adj.fxn = NULL,
      swap.rownames = NULL
    )

### Arguments

`gene` | quoted "gene" name = REQUIRED. the gene whose expression data should be retrieved.
`object` | A Seurat, SingleCellExperiment, or SummarizedExperiment object.
`assay, slot` | single strings or integer that set which data to use. Seurat and SingleCellExperiments deal with these differently, so be sure to check the documentation for whichever object you are using. When not provided, these typical defaults for the provided `object` class are used: SingleCellExperiment (single-cell or bulk data): `assay` = "logcounts", "normcounts", "counts", or the first element of assays(object), `slot` not used Seurat-v3: `assay` = DefaultAssay(object), `slot` = "data" Seurat-v2: `assay` not used, `slot` = "data"
`adjustment` | Should expression data be used directly (default) or should it be adjusted to be "z-score": scaled with the scale() function to produce a relative-to-mean z-score representation "relative.to.max": divided by the maximum expression value to give percent of max values between [0,1]
`adj.fxn` | A function which takes a vector (of metadata values) and returns a vector of the same length. For example, `function(x) {log2(x)}` or `as.factor`
`swap.rownames` | String. For SummarizeedExperiment or SingleCellExperiment objects, the column name of rowData(object) to be used to identify features instead of rownames(object).

### Value

Returns the expression values of a gene for all cells/samples.

### Author(s)

Daniel Bunis

### Examples

    example(importDittoBulk, echo = FALSE)
    gene("gene1", object = myRNA, assay = "counts")

    # z-scored
    gene("gene1", object = myRNA, assay = "counts",
        adjustment = "z-score")

    # Log2'd
    gene("gene1", object = myRNA, assay = "counts",
        adj.fxn = function(x) {log2(x)})

    # To see expression of the gene for the default assay that dittoSeq would use
    # leave out the assay input
    # (For this object, the default assay is the logcounts assay)
    gene("gene1", myRNA)

    # Seurat (raw counts)
    if (!requireNamespace("Seurat")) {
        gene("CD14", object = Seurat::pbmc, assay = "RNA", slot = "counts")
    }

[Package dittoSeq version 1.4.4 Index]