Get the number of peaks for a GRN object.

Returns the number of peaks (all or only non-filtered ones) from the provided peak datain the GRN object.

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.

See also

nTFs

nGenes

Examples

# See the Workflow vignette on the GRaNIE website for examples
GRN = loadExampleObject()
#> Downloading GRaNIE example object from https://git.embl.de/grp-zaugg/GRaNIE/-/raw/master/data/GRN.rds
#> INFO [2023-08-16 17:28:59] Storing GRN@data$RNA$counts matrix as sparse matrix because fraction of 0s is > 0.1 (0.44)
#> Finished successfully. You may explore the example object. Start by typing the object name to the console to see a summaty. Happy GRaNIE'ing!
nPeaks(GRN, filter = TRUE)
#> [1] 64008
nPeaks(GRN, filter = FALSE)
#> [1] 75000