---
title: "README"
output: html_document
bibliography: [vignettes/bibliography.bib]
---
# SOMNiBUS: SmOoth ModeliNg of BisUlfite Sequencing
Identifying disease-associated changes in DNA methylation can help us gain a better understanding of disease etiology. **SOMNiBUS** aims to analyze count-based DNA methylation (measured via bisulfite sequencing) on predefined genomic regions, such as those obtained by targeted sequencing, and thus to identify differentially methylated regions (DMRs) that are associated with phenotypes or traits. Specifically, we built a rich flexible model that allows for the effects, on the methylation levels, of multiple covariates to vary smoothly along genomic regions. At the same time, this method also allows for sequencing errors and can adjust for variability in cell type mixture. Here, penalization introduces smoothness for each covariate effect.
The package **SOMNiBUS** enable users to estimate smooth covariate effects and to assess statistical significance of methylation regions.
### Installation
Install the developer version of Bioconductor package SOMNiBUS.
```r
install.packages("BiocManager")
BiocManager::install("SOMNiBUS", version = "devel")
```
Or install the development version of `SOMNiBUS` from GitHub:
```r
if(!require("devtools")) install.packages("devtools")
devtools::install_github("kaiqiong/SOMNiBUS", build_vignettes = T)
```
## An example for getting started
An example of how to use the package:
```r
RAdat.f = na.omit(RAdat[RAdat$Total_Counts != 0,]) # filter the individual CpG sites with zero read-depth
out = binomRegMethModel(data=RAdat.f, n.k = rep(5,3), p0 = 0.003, p1 = 0.9) # run the analysis
binomRegMethModelPlot(out) # plot the smooth covariate effect
```
![](inst/Figs/BANK1.png)
See the vignette for more detailed information.
```r
vignette("SOMNiBUS")
```
## Learn more
More details of the **SOMNiBUS** method can be found in the manuscript [@Zhao2020]
# References