FRiP: Calculate fraction of reads in peaks per cell

View source: R/preprocessing.R

FRiPR Documentation

Calculate fraction of reads in peaks per cell

Description

Calculate fraction of reads in peaks per cell

Usage

FRiP(object, assay, total.fragments, col.name = "FRiP", verbose = TRUE)

Arguments

object

A Seurat object

assay

Name of the assay containing a peak x cell matrix

total.fragments

Name of a metadata column containing the total number of sequenced fragments for each cell. This can be computed using the CountFragments function.

col.name

Name of column in metadata to store the FRiP information.

verbose

Display messages

Value

Returns a Seurat object

Examples

FRiP(object = atac_small, assay = 'peaks', total.fragments = "fragments")

timoast/signac documentation built on April 5, 2024, 1:34 a.m.