peaks-methods: Get the number of peaks for a 'GRN' object.

In chrarnold/GRaNIE: GRaNIE: Reconstruction cell type specific gene regulatory networks including enhancers using chromatin accessibility and RNA-seq data

Get the number of peaks for a GRN object.

Description

Return the number of peaks (all or only non-filtered ones) that are defined in the GRN object.

Usage

nPeaks(GRN, filter = TRUE)

Arguments

GRN	Object of class GRN
filter	TRUE or FALSE. Default TRUE. Should peaks marked as filtered be included in the count?

Value

Integer. Number of peaks that are defined in the GRN object, either by excluding (filter = TRUE) or including (filter = FALSE) peaks that are currently marked as filtered.

Examples

# See the Workflow vignette on the GRaNIE website for examples
GRN = loadExampleObject()
nPeaks(GRN, filter = TRUE)
nPeaks(GRN, filter = FALSE)

chrarnold/GRaNIE documentation built on April 28, 2022, 2:18 a.m.