# `EpiCompare`: Getting started

# Overview

The EpiCompare package is designed to facilitate the comparison of epigenomic datasets for quality control and benchmarking purposes. The package combines several downstream analysis tools for epigenomic data and generates a single report that collates all results of the analysis. This allows users to conduct downstream analysis of multiple epigenomic datasets simultaneously and compare the results in a simple and efficient way.

## Introduction

For many years, ChIP-seq has been the standard method for epigenomic profiling, but it suffers from a host of limitations. Recently, many other epigenomic technologies (e.g. CUT&Run, CUT&Tag and TIP-seq etc.), designed to overcome these constraints, have been developed. To better understand the performance of these novel approaches, it is important that we systematically compare these technologies and benchmark against a “gold-standard”.

There are many tools in R (e.g. ChIPseeker) that can be used to conduct downstream analysis and comparison of epigenomic datasets. However, these are often scattered across different packages and difficult to use for researchers with none or little computational experience.

EpiCompare is designed to provide a simple and comprehensive way of analysing and comparing epigenomic datasets. It combines many useful downstream analysis tools, which can easily be controlled by users and it collates the results in a single report. This allows researchers to systematically compare different epigenomic technologies.

While the main functionality of EpiCompare is to contrast epigenomic technologies, it can also be used to compare datasets generated using different experimental conditions and data analysis workflows of one technology. This can help researchers to establish a consensus regarding the optimal use of the method.

Currently, EpiCompare supports human and mouse genomes (hg19, hg38, mm9 and mm10).

# Data

The EpiCompare package contains a small subset of histone mark H3K27ac profile data obtained/generated from:

- ENCODE (data accession: ENCFF044JNJ)
- CUT&Tag from Kaya-Okur et al., (2019). (PMID: 31036827)
- CUT&Run from Meers et al., (2019). (PMID: 31232687)

It also contains human genome hg19 and hg38 blacklisted regions obtained from ENCODE. The ENCODE blacklist includes regions of the genome that have anomalous and/or unstructured signals independent of the cell-line or experiment. Removal of ENCODE blacklist is recommended for quality measure.

These dataset will be used to showcase EpiCompare functionality

# Installation

To install the package, run the following:

    if (!require("BiocManager", quietly = TRUE))
        install.packages("BiocManager")

    BiocManager::install("EpiCompare")

# Running EpiCompare

In this example analysis, we will compare CUT&Run and CUT&Tag of histone mark H3K27ac against ENCODE ChIP-seq.

## Load package and example datasets

Once installed, load the package:

    library(EpiCompare)

    ##

Load example datasets used in this analysis:

    data("encode_H3K27ac") # ENCODE ChIP-seq
    data("CnT_H3K27ac") # CUT&Tag
    data("CnR_H3K27ac") # CUT&Run
    data("hg19_blacklist") # hg19 genome blacklist
    data("CnT_H3K27ac_picard") # CUT&Tag Picard summary output
    data("CnR_H3K27ac_picard") # CUT&Run Picard summary output

## Prepare input data

### Peaklist

EpiCompare accepts datasets both as `GRanges` object and as paths to BED files. Peakfiles (`GRanges` or paths) that you would like to analyse must be listed and named (see below).

    # To import BED files as GRanges object
    peak_GRanges <-ChIPseeker::readPeakFile("/path/to/peak/file.bed",as = "GRanges")
    # EpiCompare also accepts paths (to BED files) as input
    peak_path <- "/path/to/BED/file1.bed"
    # Create named peak list
    peaklist <- list(peak_GRanges, peak_path)
    names(peaklist) <- c("sample1", "sample2")

In this example, we will use built-in data, which have been converted into `GRanges` object previously (`CnT_H3K27ac` and `CnR_H3K27ac`).

    peaklist <- list(CnT_H3K27ac, CnR_H3K27ac) # create list of peakfiles
    names(peaklist) <- c("CnT", "CnR") # set names

### Blacklist

ENCODE blacklist contains regions of the genome that have anomalous and/or unstructured signals independent of the cell-line or experiment. Removal of these regions from peakfiles is recommended for quality measure.

EpiCompare has three built-in blacklist files, hg19, hg38 and mm10, downloaded from ENCODE. Run `?hg19_blacklist` for more information.

In this example analysis, since all peakfiles (`encode_H3K27ac`, `CnT_H3K27ac`, `CnR_H3K27ac`) were generated using human genome reference build hg19, `hg19_blacklist` will be used. For hg38, use `data(hg38_blacklist)`.

Please ensure that you specify the correct blacklist.

### Picard summary files

Note that this is OPTIONAL. If you want the report to include metrics on DNA fragments (e.g. mapped fragments and duplication rate), please input summary files from Picard.

Picard MarkDuplicates can be used to mark duplicate reads that are found within the alignment. This tool outputs a metrics file with the ending `.MarkDuplicates.metrics.txt`. To import this text file into R as data frame, use:

    picard <- read.table("/path/to/Picard/.MarkDuplicates.metrics.txt", header = TRUE, fill = TRUE)

In this example. we will use built-in data, which have been converted into data frame previously (`CnT_H3K27ac_picard` and `CnR_H3K27ac_picard`). The files must be listed and named:

    # create list of Picard summary
    picard <- list(CnT_H3K27ac_picard, CnR_H3K27ac_picard)
    names(picard) <- c("CnT", "CnR") # set names

### Reference file

This is OPTIONAL. If reference peak file is provided, `stat_plot` and `chromHMM_plot` of overlapping peaks are included in the report (see Optional plots section below).

Reference file must be listed and named. In this example, we will use built-in data (`encode_H3K27ac`), which has been converted to `GRanges` previously:

    reference_peak <- list("ENCODE_H3K27ac" = encode_H3K27ac)

### Output Directory

When running `EpiCompare()`, please ensure that you specify `output_dir`. All outputs (figures and HTML report) will be saved in the specified `output_dir`.

## Run EpiCompare

Running EpiCompare is done using the function, `EpiCompare()` . Users can choose which analyses to run and include in the report by setting parameters to `TRUE` or `FALSE`.

    EpiCompare(peakfiles = peaklist,
               genome_build = "hg19",
               blacklist = hg19_blacklist,
               picard_files = picard,
               reference = reference_peak,
               upset_plot = FALSE,
               stat_plot = FALSE,
               chromHMM_plot = FALSE,
               chromHMM_annotation = "K562",
               chipseeker_plot = FALSE,
               enrichment_plot = FALSE,
               tss_plot = FALSE,
               interact = FALSE,
               save_output = FALSE,
               output_filename = "EpiCompare_test",
               output_timestamp = FALSE,
               output_dir = tempdir())

    ## NOTE: The following EpiCompare features are NOT being used:
    ##  - peak_score_plot=
    ##  - upset_plot=
    ##  - stat_plot=
    ##  - chromHMM_plot=
    ##  - chipseeker_plot=
    ##  - enrichment_plot=
    ##  - tss_plot=
    ##  - precision_recall_plot=
    ##  - corr_plot=
    ##  - add_download_button=

    ## processing file: EpiCompare.Rmd

    ## output file: EpiCompare.knit.md

    ## /usr/local/bin/pandoc +RTS -K512m -RTS EpiCompare.knit.md --to html4 --from markdown+autolink_bare_uris+tex_math_single_backslash --output /tmp/RtmpcklWgS/EpiCompare_test.html --lua-filter /github/workspace/pkglib/rmarkdown/rmarkdown/lua/pagebreak.lua --lua-filter /github/workspace/pkglib/rmarkdown/rmarkdown/lua/latex-div.lua --lua-filter /github/workspace/pkglib/rmarkdown/rmarkdown/lua/table-classes.lua --embed-resources --standalone --variable bs3=TRUE --section-divs --table-of-contents --toc-depth 3 --variable toc_float=1 --variable toc_selectors=h1,h2,h3 --variable toc_collapsed=1 --variable toc_smooth_scroll=1 --variable toc_print=1 --template /github/workspace/pkglib/rmarkdown/rmd/h/default.html --no-highlight --variable highlightjs=1 --number-sections --variable theme=bootstrap --css custom.css --mathjax --variable 'mathjax-url=https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML' --include-in-header /tmp/RtmpcklWgS/rmarkdown-str2a735bc6d88e.html --variable code_folding=hide --variable code_menu=1

    ##
    ## Output created: /tmp/RtmpcklWgS/EpiCompare_test.html

    ## [1] "Done in 0.08 min."

    ## All outputs saved to: /tmp/RtmpcklWgS

    ## [1] "/tmp/RtmpcklWgS/EpiCompare_test.html"

### Optional plots

By default, these plots will not be included in the report unless set `TRUE`.

- `upset_plot` : Upset plot showing the number of overlapping peaks between samples. EpiCompare uses `UpSetR` package.
- `stat_plot` : A `reference` peakfile must be included for this plot. The plot displays distribution of statistical significance (q-values) of sample peaks that are overlapping/non-overlapping with the `reference` dataset.
- `chromHMM_plot` : ChromHMM annotation of peaks. If `reference` is provided, ChromHMM annotation of overlapping and non-overlapping peaks with the `reference` is also included in the report.
- `chipseeker_plot` : `ChIPseeker` functional annotation of peaks.
- `enrichment_plot` : KEGG pathway and GO enrichment analysis of peaks.
- `tss_plot` : Peak frequency around (+/- 3000bp) transcriptional start site. Note that it may take awhile to generate this plot for large sample sizes.

### Other options

- `chromHMM_annotation` : Cell-line annotation for ChromHMM. Default is K562. Options are:
  - “K562” = K-562 cells
  - “Gm12878” = Cellosaurus cell-line GM12878
  - “H1hesc” = H1 Human Embryonic Stem Cell
  - “Hepg2” = Hep G2 cell
  - “Hmec” = Human Mammary Epithelial Cell
  - “Hsmm” = Human Skeletal Muscle Myoblasts
  - “Huvec” = Human Umbilical Vein Endothelial Cells
  - “Nhek” = Normal Human Epidermal Keratinocytes
  - “Nhlf” = Normal Human Lung Fibroblasts
- `interact` : By default, all heatmaps (percentage overlap and ChromHMM heatmaps) in the report will be interactive. If set FALSE, all heatmaps will be static. N.B. If `interact=TRUE`, interactive heatmaps will be saved as html files, which may take time for larger sample sizes.
- `output_filename` : By default, the report is named EpiCompare.html. You can specify the filename of the report here.
- `output_timestamp` : By default FALSE. If TRUE, the filename of the report includes the date.

## Output

EpiCompare outputs

- An HTML report consisting of three sections:
  - 1. General Metrics: Metrics on peaks (percentage of blacklisted and non-standard peaks, and peak widths) and fragments (duplication rate) of samples.
  - 2. Peak Overlap: Percentage and statistical significance of overlapping and non-overlapping peaks. Also includes upset plot.
  - 3. Functional Annotation: Functional annotation (ChromHMM, ChIPseeker and enrichment analysis) of peaks. Also includes peak enrichment around TSS.
- `EpiCompare_file` containing all plots generated by EpiCompare if `save_output = TRUE`.

Both outputs are saved in the specified `output_dir`.

# Future Enhancements

In the current version, EpiCompare only recognizes certain BED formats. We hope to improve this. Moreover, if there are other downstream analysis tools that may be suitable in EpiCompare, feel free to report this through Github.

# Code used to generate the example report

An example report comparing ATAC-seq, DNase-seq and ChIP-seq of K562 can be found here.

Code used to generate this:

    ## Load data
    # ATAC-seq data: https://www.encodeproject.org/files/ENCFF558BLC/
    atac1_hg38 <- ChIPseeker::readPeakFile("/path/to/bed/ENCFF558BLC.bed", as="GRanges")
    # Dnase-seq data: https://www.encodeproject.org/files/ENCFF274YGF/
    dna1_hg38 <- ChIPseeker::readPeakFile("/path/to/bed/ENCFF274YGF.bed", as="GRanges")
    # Dnase-seq data: https://www.encodeproject.org/files/ENCFF185XRG/
    dna2_hg38 <- ChIPseeker::readPeakFile("/path/to/bed/ENCFF185XRG.bed", as="GRanges")
    # ChIP-seq data: https://www.encodeproject.org/files/ENCFF038DDS/
    chip_hg38 <- ChIPseeker::readPeakFile("/path/to/bed/ENCODE_H3K27ac_hg38_ENCFF038DDS.bed", as="GRanges")

    ## Peaklist
    peaklist <- list("ATAC_ENCFF558BLC" = atac1_hg38_unique,
                     "Dnase_ENCFF274YGF" = dna1_hg38,
                     "ChIP_ENCFF038DDS" = chip_hg38)

    ## Reference
    reference <- list("Dnase_ENCFF185XRG_reference"=dna2_hg38)

    ## Blacklist
    data("hg38_blacklist")

    ## Run Epicompare
    EpiCompare(peakfiles = peaklist,
               genome_build = "hg38",
               genome_build_output = "hg38",
               blacklist = hg38_blacklist,
               reference = reference,
               picard_files = NULL,
               upset_plot = T,
               stat_plot = T,
               save_output = F,
               chromHMM_plot = T,
               chromHMM_annotation = "K562",
               chipseeker_plot = T,
               enrichment_plot = T,
               tss_plot = T,
               precision_recall_plot =T,
               corr_plot = T,
               interact = T,
               output_dir = "/path/")

# Session Information

    utils::sessionInfo()

    ## R version 4.5.2 (2025-10-31)
    ## Platform: x86_64-pc-linux-gnu
    ## Running under: Ubuntu 24.04.3 LTS
    ##
    ## Matrix products: default
    ## BLAS:   /usr/lib/x86_64-linux-gnu/openblas-pthread/libblas.so.3
    ## LAPACK: /usr/lib/x86_64-linux-gnu/openblas-pthread/libopenblasp-r0.3.26.so;  LAPACK version 3.12.0
    ##
    ## locale:
    ##  [1] LC_CTYPE=en_US.UTF-8       LC_NUMERIC=C
    ##  [3] LC_TIME=en_US.UTF-8        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: Etc/UTC
    ## tzcode source: system (glibc)
    ##
    ## attached base packages:
    ## [1] stats     graphics  grDevices utils     datasets  methods   base
    ##
    ## other attached packages:
    ## [1] EpiCompare_1.15.2 BiocStyle_2.39.0
    ##
    ## loaded via a namespace (and not attached):
    ##   [1] BiocIO_1.21.0
    ##   [2] bitops_1.0-9
    ##   [3] ggplotify_0.1.3
    ##   [4] filelock_1.0.3
    ##   [5] tibble_3.3.1
    ##   [6] polyclip_1.10-7
    ##   [7] enrichit_0.1.0
    ##   [8] XML_3.99-0.20
    ##   [9] lifecycle_1.0.5
    ##  [10] httr2_1.2.2
    ##  [11] lattice_0.22-7
    ##  [12] MASS_7.3-65
    ##  [13] magrittr_2.0.4
    ##  [14] plotly_4.12.0
    ##  [15] sass_0.4.10
    ##  [16] rmarkdown_2.30
    ##  [17] jquerylib_0.1.4
    ##  [18] yaml_2.3.12
    ##  [19] plotrix_3.8-13
    ##  [20] otel_0.2.0
    ##  [21] ggtangle_0.1.1
    ##  [22] DBI_1.2.3
    ##  [23] buildtools_1.0.0
    ##  [24] RColorBrewer_1.1-3
    ##  [25] lubridate_1.9.4
    ##  [26] abind_1.4-8
    ##  [27] GenomicRanges_1.63.1
    ##  [28] purrr_1.2.1
    ##  [29] BiocGenerics_0.57.0
    ##  [30] RCurl_1.98-1.17
    ##  [31] yulab.utils_0.2.3
    ##  [32] tweenr_2.0.3
    ##  [33] rappdirs_0.3.4
    ##  [34] gdtools_0.4.4
    ##  [35] IRanges_2.45.0
    ##  [36] S4Vectors_0.49.0
    ##  [37] enrichplot_1.31.4
    ##  [38] ggrepel_0.9.6
    ##  [39] tidytree_0.4.7
    ##  [40] maketools_1.3.2
    ##  [41] ChIPseeker_1.47.1
    ##  [42] codetools_0.2-20
    ##  [43] DelayedArray_0.37.0
    ##  [44] DOSE_4.5.1
    ##  [45] ggforce_0.5.0
    ##  [46] tidyselect_1.2.1
    ##  [47] aplot_0.2.9
    ##  [48] UCSC.utils_1.7.1
    ##  [49] farver_2.1.2
    ##  [50] base64enc_0.1-3
    ##  [51] matrixStats_1.5.0
    ##  [52] stats4_4.5.2
    ##  [53] BiocFileCache_3.1.0
    ##  [54] Seqinfo_1.1.0
    ##  [55] GenomicAlignments_1.47.0
    ##  [56] jsonlite_2.0.0
    ##  [57] systemfonts_1.3.1
    ##  [58] tools_4.5.2
    ##  [59] ggnewscale_0.5.2
    ##  [60] treeio_1.35.0
    ##  [61] TxDb.Hsapiens.UCSC.hg19.knownGene_3.22.1
    ##  [62] Rcpp_1.1.1
    ##  [63] glue_1.8.0
    ##  [64] SparseArray_1.11.10
    ##  [65] xfun_0.56
    ##  [66] MatrixGenerics_1.23.0
    ##  [67] GenomeInfoDb_1.47.2
    ##  [68] dplyr_1.1.4
    ##  [69] withr_3.0.2
    ##  [70] BiocManager_1.30.27
    ##  [71] fastmap_1.2.0
    ##  [72] boot_1.3-32
    ##  [73] caTools_1.18.3
    ##  [74] digest_0.6.39
    ##  [75] mime_0.13
    ##  [76] timechange_0.4.0
    ##  [77] R6_2.6.1
    ##  [78] gridGraphics_0.5-1
    ##  [79] seqPattern_1.43.0
    ##  [80] GO.db_3.22.0
    ##  [81] gtools_3.9.5
    ##  [82] RSQLite_2.4.5
    ##  [83] cigarillo_1.1.0
    ##  [84] tidyr_1.3.2
    ##  [85] generics_0.1.4
    ##  [86] fontLiberation_0.1.0
    ##  [87] data.table_1.18.2.1
    ##  [88] rtracklayer_1.71.3
    ##  [89] bsplus_0.1.5
    ##  [90] httr_1.4.7
    ##  [91] htmlwidgets_1.6.4
    ##  [92] S4Arrays_1.11.1
    ##  [93] scatterpie_0.2.6
    ##  [94] downloadthis_0.5.0
    ##  [95] pkgconfig_2.0.3
    ##  [96] gtable_0.3.6
    ##  [97] blob_1.3.0
    ##  [98] S7_0.2.1
    ##  [99] impute_1.85.0
    ## [100] XVector_0.51.0
    ## [101] sys_3.4.3
    ## [102] htmltools_0.5.9
    ## [103] fontBitstreamVera_0.1.1
    ## [104] scales_1.4.0
    ## [105] Biobase_2.71.0
    ## [106] png_0.1-8
    ## [107] ggfun_0.2.0
    ## [108] knitr_1.51
    ## [109] tzdb_0.5.0
    ## [110] reshape2_1.4.5
    ## [111] rjson_0.2.23
    ## [112] nlme_3.1-168
    ## [113] curl_7.0.0
    ## [114] cachem_1.1.0
    ## [115] stringr_1.6.0
    ## [116] BiocVersion_3.23.1
    ## [117] KernSmooth_2.23-26
    ## [118] parallel_4.5.2
    ## [119] AnnotationDbi_1.73.0
    ## [120] restfulr_0.0.16
    ## [121] pillar_1.11.1
    ## [122] grid_4.5.2
    ## [123] vctrs_0.7.1
    ## [124] gplots_3.3.0
    ## [125] tidydr_0.0.6
    ## [126] dbplyr_2.5.1
    ## [127] cluster_2.1.8.1
    ## [128] evaluate_1.0.5
    ## [129] readr_2.1.6
    ## [130] GenomicFeatures_1.63.1
    ## [131] cli_3.6.5
    ## [132] compiler_4.5.2
    ## [133] Rsamtools_2.27.0
    ## [134] rlang_1.1.7
    ## [135] crayon_1.5.3
    ## [136] labeling_0.4.3
    ## [137] plyr_1.8.9
    ## [138] fs_1.6.6
    ## [139] ggiraph_0.9.3
    ## [140] stringi_1.8.7
    ## [141] genomation_1.43.0
    ## [142] viridisLite_0.4.2
    ## [143] gridBase_0.4-7
    ## [144] BiocParallel_1.45.0
    ## [145] Biostrings_2.79.4
    ## [146] lazyeval_0.2.2
    ## [147] GOSemSim_2.37.2
    ## [148] fontquiver_0.2.1
    ## [149] Matrix_1.7-4
    ## [150] BSgenome_1.79.1
    ## [151] hms_1.1.4
    ## [152] patchwork_1.3.2
    ## [153] bit64_4.6.0-1
    ## [154] ggplot2_4.0.1
    ## [155] KEGGREST_1.51.1
    ## [156] SummarizedExperiment_1.41.0
    ## [157] AnnotationHub_4.1.0
    ## [158] igraph_2.2.1
    ## [159] memoise_2.0.1
    ## [160] bslib_0.10.0
    ## [161] ggtree_4.1.1
    ## [162] bit_4.6.0
    ## [163] ape_5.8-1