Skip to content

Latest commit

 

History

History
62 lines (49 loc) · 4.97 KB

README.md

File metadata and controls

62 lines (49 loc) · 4.97 KB

DMRichR

DOI R-CMD-check-bioc Lifecycle: stable

Enrich Your Differentially Methylated Region (DMR) Analysis with the Tidyverse

Website: ben-laufer.github.io/DMRichR/

Overview

DMRichR is an R package and executable for the preprocessing, statistical analysis, and visualization of differentially methylated regions (DMRs) and global methylation levels from CpG count matrices (Bismark cytosine reports). These files can be generated from your own pipeline or through the CpG_Me pipeline.

DMRichR enables the analysis of data from whole genome bisulfite sequencing (WGBS), enzymatic methyl-seq (EM-seq), and reduced representation bisulfite sequencing (RRBS). The overarching theme of DMRichR is the synthesis of popular Bioconductor R packages for the analysis of genomic data with the tidyverse philosophy of R programming.

DMRichR::DM.R() is a single function that performs all of the following steps:

Overview of DMRichR Workflow

Installation

You can install the package using the following code:

if(!requireNamespace("BiocManager", quietly = TRUE))
  install.packages("BiocManager")
if(!requireNamespace("remotes", quietly = TRUE))
  install.packages("remotes")
Sys.setenv("R_REMOTES_NO_ERRORS_FROM_WARNINGS" = TRUE)
BiocManager::install("ben-laufer/DMRichR")

If you are running into installation errors with the package dependencies, make sure that you have bioconductor v3.16 and R v4.2 installed. macOS users will have to install XQuartz manually or through Homebrew using brew install xquartz --cask.

Website Table of Contents

  1. DMR Approach and Interpretation
  2. Input
    1. Design Matrix and Covariates
    2. Cytosine Reports
  3. Running DMRichR
    1. R Example
    2. Command Line Example
    3. UC Davis Example
  4. Workflow and Output
    1. Preprocess Cytosine Reports
    2. Blocks
    3. DMRs
    4. Smoothed Individual Methylation Values
    5. ChromHMM and Reference Epigenome Enrichments
    6. Transcription Factor Motif Enrichments
    7. Global Methylation Analyses and Plots
    8. DMR Heatmap
    9. DMR Annotations
    10. Manhattan plot
    11. Gene Ontology Enrichments
    12. Machine Learning
    13. RData
  5. Publications
  6. Acknowledgements