KnowYourCG (KYCG) is a supervised learning framework designed for the functional analysis of DNA methylation data. Unlike existing tools that focus on genes or genomic intervals, KnowYourCG directly targets CpG dinucleotides, featuring automated supervised screenings of diverse biological and technical influences, including sequence motifs, transcription factor binding, histone modifications, replication timing, cell-type-specific methylation, and trait associations. KnowYourCG addresses the challenges of data sparsity in various methylation datasets, including low-pass Nanopore sequencing, single-cell DNA methylomes, 5-hydroxymethylation profiles, spatial DNA methylation maps, and array-based datasets for epigenome-wide association studies and epigenetic clocks.
The input to KYCG is a CpG set (query). The CpG sets can represent differential methylation, results from an epigenome-wide association studies, or any sets that may be derived from analysis. If array experiment, the preferred format of the query sets is a character vector of cg-numbers, following the standard Infinium array naming nomenclature.
The following commands prepare the use of knowYourCG. Several database sets are retrieved and caching is performed to enable faster access in future enrichment testing. More information on viewing and accessing available database sets is discussed later on.
library(knowYourCG)
library(sesameData)
sesameDataCache(data_titles=c("genomeInfo.hg38","genomeInfo.mm10",
"KYCG.MM285.tissueSignature.20211211",
"MM285.tissueSignature","MM285.address",
"probeIDSignature","KYCG.MM285.designGroup.20210210",
"KYCG.MM285.chromHMM.20210210",
"KYCG.MM285.TFBSconsensus.20220116",
"KYCG.MM285.HMconsensus.20220116",
"KYCG.MM285.chromosome.mm10.20210630"
))
The following example uses a query of CpGs methylated in mouse primordial germ cells (design group PGCMeth). First get the CG list using the following code.
## [1] "cg36615889_TC11" "cg36646136_BC21" "cg36647910_BC11" "cg36857173_TC21"
## [5] "cg36877289_BC21" "cg36899653_BC21"
Now test the enrichment. By default, KYCG will select all the categorical groups available but we can specify a subset of databases.
dbs <- c("KYCG.MM285.chromHMM.20210210",
"KYCG.HM450.TFBSconsensus.20211013",
"KYCG.MM285.HMconsensus.20220116",
"KYCG.MM285.tissueSignature.20211211",
"KYCG.MM285.chromosome.mm10.20210630",
"KYCG.MM285.designGroup.20210210")
results_pgc <- testEnrichment(query,databases = dbs,platform="MM285")
head(results_pgc)
As expected, the PGCMeth group itself appears on the top of the list.
But one can also find histone H3K9me3, chromHMM Het
and
transcription factor Trim28
binding enriched in this CG
group.
The curated target features are called the knowledgebase sets. We have curated a variety of knowledgebases that represent different categorical and continuous methylation features such as CpGs associated with chromatin states, technical artifacts, gene association and gene expression correlation, transcription factor binding sites, tissue specific methylation, CpG density, etc.
Array knowledgebases are available as listed in the following tables.
Array | Link |
---|---|
MSA | https://github.com/zhou-lab/KYCG_knowledgebase_MSA |
Human (EPICv2) | https://github.com/zhou-lab/KYCG_knowledgebase_EPICv2 |
Human (EPIC) | https://github.com/zhou-lab/KYCG_knowledgebase_EPIC |
Human (HM450) | https://github.com/zhou-lab/KYCG_knowledgebase_HM450 |
The success of enrichment testing depends on the availability of biologically-relevant databases. To reflect the biological meaning of databases and facilitate selective testing, we have organized our database sets into different groups. Each group contains one or multiple databases. Here is how to find the names of pre-built database groups:
The listDBGroups()
function returns a data frame
containing information of these databases. The Title column is the
accession key one needs for the testEnrichment
function.
With the accessions, one can either directly use them in the
testEnrichment
function or explicitly call the
getDBs()
function to retrieve databases themselves. Caching
these databases on the local machine is important, for two reasons: it
limits the number of requests sent to the Bioconductor server, and
secondly it limits the amount of time the user needs to wait when
re-downloading database sets. For this reason, one should run
sesameDataCache()
before loading in any database sets. This
will take some time to download all of the database sets but this only
needs to be done once per installation. During the analysis the database
sets can be identified using these accessions. knowYourCG also does some
guessing when a unique substring is given. For example, the string
“MM285.designGroup” retrieves the “KYCG.MM285.designGroup.20210210”
database. Let’s look at the database group which we had used as the
query (query and database are reciprocal) in our first example:
## Selected the following database groups:
## 1. KYCG.MM285.designGroup.20210210
In total, 32 datasets have been loaded for this group. We can get the “PGCMeth” as an element of the list:
## chr [1:474] "cg36615889_TC11" "cg36646136_BC21" "cg36647910_BC11" ...
## - attr(*, "group")= chr "KYCG.MM285.designGroup.20210210"
## - attr(*, "dbname")= chr "PGCMeth"
On subsequent runs of the getDBs()
function, the
database loading can be faster thanks to the sesameData in-memory caching, if the
corresponding database has been loaded.
The main work horse function for testing enrichment of a categorical
query against categorical databases is the testEnrichment
function. This function will perform Fisher’s exact testing of the query
against each database set (one-tailed by default, but two-tailed
optionally) and reports overlap and enrichment statistics.
Choice of universe set: Universe set is the set of all probes for a given platform. It can either be passed in as an argument called
universeSet
or the platform name can be passed with argumentplatform
. If neither of these are supplied, the universe set will be inferred from the probes in the query.
library(SummarizedExperiment)
## prepare a query
df <- rowData(sesameDataGet('MM285.tissueSignature'))
query <- df$Probe_ID[df$branch == "fetal_brain" & df$type == "Hypo"]
results <- testEnrichment(query, "TFBS", platform="MM285")
results %>% dplyr::filter(overlap>10) %>% head
## prepare another query
query <- df$Probe_ID[df$branch == "fetal_liver" & df$type == "Hypo"]
results <- testEnrichment(query, "TFBS", platform="MM285")
results %>% dplyr::filter(overlap>10) %>%
dplyr::select(dbname, estimate, test, FDR) %>% head
The output of each test contains multiple variables including: the estimate (fold enrichment), p-value, overlap statistics, type of test, as well as the name of the database set and the database group. By default, the results are sorted by -log10 of the of p-value and the fold enrichment.
The nQ
and nD
columns identify the length
of the query set and the database set, respectively. Often, it’s
important to examine the extent of overlap between the two sets, so that
metric is reported as well in the overlap
column.
A query set represents probes of interest. It may either be in the form of a character vector where the values correspond to probe IDs or a named numeric vector where the names correspond to probe IDs. The query and database definition is rather arbitrary. One can regard a database as a query and turn a query into a database, like in our first example. In real world scenario, query can come from differential methylation testing, unsupervised clustering, correlation with a phenotypic trait, and many others. For example, we could consider CpGs that show tissue-specific methylation as the query. We are getting the B-cell-specific hypomethylation.
df <- rowData(sesameDataGet('MM285.tissueSignature'))
query <- df$Probe_ID[df$branch == "B_cell"]
head(query)
## [1] "cg32668003_TC11" "cg45118317_TC11" "cg37563895_TC11" "cg46105105_BC11"
## [5] "cg47206675_TC21" "cg38855216_TC21"
This query set represents hypomethylated probes in Mouse B-cells from the MM285 platform. This specific query set has 168 probes.
A special case of set enrichment is to test whether CpGs are
associated with specific genes. Automating the enrichment test process
only works when the number of database sets is small. This is important
when targeting all genes as there are tens of thousands of genes on each
platform. By testing only those genes that overlap with the query set,
we can greatly reduce the number of tests. For this reason, the gene
enrichment analysis is a special case of these enrichment tests. We can
perform this analysis using the buildGeneDBs()
function.
library(knowYourCG)
library(sesameData)
library(SummarizedExperiment)
query <- names(sesameData_getProbesByGene("Dnmt3a", "MM285"))
results <- testEnrichment(query,
buildGeneDBs(query, max_distance=100000, platform="MM285"),
platform="MM285")
main_stats <- c("dbname","estimate","gene_name","FDR", "nQ", "nD", "overlap")
results[,main_stats]
As expected, we recover our targeted gene (Dnmt3a).
Gene enrichment testing can easily be included with default or user specified database sets by setting include_genes=TRUE:
query <- names(sesameData_getProbesByGene("Dnmt3a", "MM285"))
dbs <- c("KYCG.MM285.chromHMM.20210210","KYCG.HM450.TFBSconsensus.20211013",
"KYCG.MM285.chromosome.mm10.20210630")
results <- testEnrichment(query,databases=dbs,
platform="MM285",include_genes=TRUE)
main_stats <- c("dbname","estimate","gene_name","FDR", "nQ", "nD", "overlap")
results[,main_stats] %>%
head()
One can get all the genes associated with a probe set and test the
Gene Ontology of the probe-associated genes using the
testGO()
function, which internally utilizes g:Profiler2 for the
enrichment analysis:
library(gprofiler2)
df <- rowData(sesameDataGet('MM285.tissueSignature'))
query <- df$Probe_ID[df$branch == "fetal_liver" & df$type == "Hypo"]
res <- testGO(query, platform="MM285",organism = "mmusculus")
head(res$result)
Sometimes it may be of interest whether a query set of probes share
close genomic proximity. Co-localization may suggest co-regulation or
co-occupancy in the same regulatory element. KYCG can test for genomic
proximity using the testProbeProximity()
function. Poisson
statistics for the expected # of co-localized hits from the given query
size (lambda) and the actual co-localized CpG pairs along with the p
value are returned:
df <- rowData(sesameDataGet('MM285.tissueSignature'))
probes <- df$Probe_ID[df$branch == "fetal_liver" & df$type == "Hypo"]
res <- testProbeProximity(probeIDs=probes)
head(res)
## $Stats
## nQ Hits Lambda P.val
## 1 194 4 0.1 7.667802e-08
##
## $Clusters
## seqnames start end distance
## 1 chr1 165770666 165770667 11
## 2 chr1 165770677 165770678 377829
## 3 chr5 75601915 75601916 29
## 4 chr5 75601944 75601945 73617660
## 5 chr9 110235046 110235047 26
## 6 chr9 110235072 110235073 NA
## 7 chr11 32245638 32245639 95
## 8 chr11 32245733 32245734 63088309
## R Under development (unstable) (2024-10-21 r87258)
## Platform: x86_64-pc-linux-gnu
## Running under: Ubuntu 24.04.1 LTS
##
## Matrix products: default
## BLAS: /home/biocbuild/bbs-3.21-bioc/R/lib/libRblas.so
## LAPACK: /usr/lib/x86_64-linux-gnu/lapack/liblapack.so.3.12.0
##
## locale:
## [1] LC_CTYPE=en_US.UTF-8 LC_NUMERIC=C
## [3] LC_TIME=en_GB LC_COLLATE=C
## [5] LC_MONETARY=en_US.UTF-8 LC_MESSAGES=en_US.UTF-8
## [7] LC_PAPER=en_US.UTF-8 LC_NAME=C
## [9] LC_ADDRESS=C LC_TELEPHONE=C
## [11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C
##
## time zone: America/New_York
## tzcode source: system (glibc)
##
## attached base packages:
## [1] stats4 stats graphics grDevices utils datasets methods
## [8] base
##
## other attached packages:
## [1] gprofiler2_0.2.3 SummarizedExperiment_1.37.0
## [3] Biobase_2.67.0 GenomicRanges_1.59.1
## [5] GenomeInfoDb_1.43.2 IRanges_2.41.2
## [7] S4Vectors_0.45.2 MatrixGenerics_1.19.0
## [9] matrixStats_1.4.1 sesameData_1.25.0
## [11] ExperimentHub_2.15.0 AnnotationHub_3.15.0
## [13] BiocFileCache_2.15.0 dbplyr_2.5.0
## [15] BiocGenerics_0.53.3 generics_0.1.3
## [17] knowYourCG_1.3.13
##
## loaded via a namespace (and not attached):
## [1] tidyselect_1.2.1 viridisLite_0.4.2 dplyr_1.1.4
## [4] blob_1.2.4 bitops_1.0-9 filelock_1.0.3
## [7] Biostrings_2.75.3 RCurl_1.98-1.16 lazyeval_0.2.2
## [10] fastmap_1.2.0 digest_0.6.37 lifecycle_1.0.4
## [13] KEGGREST_1.47.0 RSQLite_2.3.9 magrittr_2.0.3
## [16] compiler_4.5.0 rlang_1.1.4 sass_0.4.9
## [19] tools_4.5.0 yaml_2.3.10 data.table_1.16.4
## [22] knitr_1.49 htmlwidgets_1.6.4 S4Arrays_1.7.1
## [25] bit_4.5.0.1 curl_6.0.1 DelayedArray_0.33.3
## [28] plyr_1.8.9 RColorBrewer_1.1-3 abind_1.4-8
## [31] withr_3.0.2 purrr_1.0.2 grid_4.5.0
## [34] wheatmap_0.2.0 colorspace_2.1-1 ggplot2_3.5.1
## [37] scales_1.3.0 cli_3.6.3 rmarkdown_2.29
## [40] crayon_1.5.3 httr_1.4.7 reshape2_1.4.4
## [43] tzdb_0.4.0 DBI_1.2.3 cachem_1.1.0
## [46] stringr_1.5.1 AnnotationDbi_1.69.0 BiocManager_1.30.25
## [49] XVector_0.47.1 vctrs_0.6.5 Matrix_1.7-1
## [52] jsonlite_1.8.9 hms_1.1.3 bit64_4.5.2
## [55] ggrepel_0.9.6 plotly_4.10.4 tidyr_1.3.1
## [58] jquerylib_0.1.4 glue_1.8.0 stringi_1.8.4
## [61] gtable_0.3.6 BiocVersion_3.21.1 UCSC.utils_1.3.0
## [64] munsell_0.5.1 tibble_3.2.1 pillar_1.10.0
## [67] rappdirs_0.3.3 htmltools_0.5.8.1 GenomeInfoDbData_1.2.13
## [70] R6_2.5.1 evaluate_1.0.1 lattice_0.22-6
## [73] readr_2.1.5 png_0.1-8 memoise_2.0.1
## [76] bslib_0.8.0 Rcpp_1.0.13-1 SparseArray_1.7.2
## [79] xfun_0.49 pkgconfig_2.0.3