Note: This function, as all get functions from this package, does NOT return a GRN object.

getGRNSummary(GRN, silent = FALSE)



Object of class GRN


TRUE or FALSE. Default FALSE. Should the function be silent and print nothing?


A named list summarizing the GRN object. This function does **NOT** return a GRN object, but instead a named lsit with the following elements:

  • data:

    • peaks, genes and TFs:

    • sharedSamples:

    • metadata:

  • parameters and config: GRN parameters and config information

  • connections: Connection summary for different connection types

    • TF_peak: TF-peak (number of connections for different FDR thresholds)

    • peak_genes: Peak-gene

    • TF_peak_gene: TF-peak-gene

  • network: Network-related summary, including the number of nodes, edges, communities and enrichment for both the TF-peak-gene and TF-gene network

    • TF_gene

    • TF_peak_gene


# See the Workflow vignette on the GRaNIE website for examples
GRN = loadExampleObject()
#> Downloading GRaNIE example object from
#> Finished successfully. You may explore the example object. Start by typing the object name to the console to see a summaty. Happy GRaNIE'ing!
summary.l = getGRNSummary(GRN)
#> INFO [2024-04-04 17:37:27]  Finished successfully. Execution time: 4.7 secs