addPerCellQCMetrics {scuttle} | R Documentation

## Add QC metrics to a SummarizedExperiment

### Description

Convenient utilities to compute QC metrics and add them to a SummarizedExperiment's row or column metadata.

### Usage

    addPerCellQCMetrics(x, ...)

    addPerFeatureQCMetrics(x, ...)

    addPerCellQC(x, ...)

    addPerFeatureQC(x, ...)

### Arguments

`x` | A SummarizedExperiment object or one of its subclasses.
`...` | For `addPerCellQCMetrics`, further arguments to pass to `perCellQCMetrics`. For `addPerFeatureQCMetrics`, further arguments to pass to `perFeatureQCMetrics`.

### Details

These functions are simply wrappers around `perCellQCMetrics` and `perFeatureQCMetrics`, respectively. The computed QC metrics are automatically appended onto the existing `colData` or `rowData`. No protection is provided against duplicated column names.

`addPerCellQC` and `addPerFeatureQC` are exactly the same functions, sans the `Metrics` at the end of their names. They were added in the tempestuous youth of this package when naming was fast and loose. These can be considered to be soft-deprecated in favor of the longer forms.

### Value

`x` is returned with the QC metrics added to the row or column metadata.

### Author(s)

Aaron Lun

### See Also

`perCellQCMetrics` and `perFeatureQCMetrics`, which do the actual work.

### Examples

    example_sce <- mockSCE()
    example_sce <- addPerCellQCMetrics(example_sce)
    colData(example_sce)

    example_sce <- addPerFeatureQCMetrics(example_sce)
    rowData(example_sce)

[Package scuttle version 1.2.1 Index]