runMetrics: Run metrics

View source: R/runMetrics.R

runMetricsR Documentation

Run metrics

Description

Calculates the overdispersion and the breakpoint counts for each cell.

Usage

runMetrics(scCNA, BPPARAM = bpparam())

Arguments

scCNA

scCNA object.

BPPARAM

A BiocParallelParam specifying how the function should be parallelized.

Details

Adds the metrics to the scCNA colData. Those metrics can be used for subsetting the data if desired. results can be visualized with plotMetrics.

Value

Adds columns 'overdispersion' and 'breakpoint_count' to colData.

Author(s)

Darlan Conterno Minussi

Examples

copykit_obj <- mock_bincounts()
copykit_obj <- runMetrics(copykit_obj)

navinlabcode/copykit documentation built on Sept. 22, 2023, 9:16 a.m.