1. What is CalcEnrichment?

CalcEnrichment is a program that calculate basic statistics of DNA methylome data. It report depth of reads, methylation rates and so on. This program is intended for use with targeted bisulfite sequencing (TBS) data. For whole-genome bisulfite sequencing (WGBS), you may have interested in CalcCoverage.


2. How to use CalcEnrichment


CalcEnrichment uses graph file for its calculation. So, before using CalcCoverage,  you have to prepare graph file with MPTC.

A typical command is as following.

>CalcEnrichment -graph YFN.graph -bed target.bed -out YFN.html

After completion of the command, a file reporting basic statistics of methylome data will appear (i.e. "YFN.html" in the example above ).


Command line options for CalcEnrichment

Option Value type Descriptions
-graph string Specify the path to graph file. There are some programs that can create graph file(s), CalcCoverage accept only graph files created by MPTC. [requred]
-bed string Specify the path to bed file that contains coordinates for target sites. [requred]
-topstrand none Specify the target strand to top strand. [exclusive with -topstrand and -bothstrand]
-bottomstrand none Specify the target strand to bottom strand. [exclusive with -topstrand and -bothstrand]
-bothstrand none Specify the target strand to bothstrand. [exclusive with -topstrand and -bottomstrand]
-out string Specify the paths to output file. If the path contains an extension "html",  output of CalcEnrichment becomes graphical one. [requred]

3. How to compile CalcEnrichment

CalcEnrichment is coded with the C++ library Qt, you can compile and use it on the platforms supported by Qt. The source code is available from here.

Once you correctly install Qt in your system, you can easily compile the source codes. After extraction of the source codes to an appropriate directory, change working directory to the directory and type the following commands.

>qmake CalcEnrichment.pro
>make (or nmake for Visual Studio on Windows)

After completion of the commands, you can find an executable file in the directory named "bin" located at the same layer with the directory of the source code.


4. A Notice for running CalcEnrichment in graphical mode

In some platforms, CalcEnrichment uses functions provided by an open source library QCustomPlot in graphical html output mode. Since  QCustomPlot requires X-window system, CalcEnrichment needs both a launched X-server process and a correct environment variable "DISPLAY". If CalcEnrichment can not find X-window system, an error message like following will appear.

>CalcCoverage : cannot connect to X server localhost:10.0

To solve this, we use virtual X11 display server Xvfb. After installing Xvfb appropreately, we type following command to launch Xvfb.

>Xvfb :1 -screen 0 1024x768x24 1>/dev/null 2>/dev/null &

 Then set an environment variable "DISPLAY" with typing following command.

>export DISPLAY=:1.0

After completion of runnning CalcCoverage, the Xvfb process can be killed as following.

>kill Xvfb

5. Precompiled executables

For your convenience, executable files are prepared as follows.

Platform compiled (Qt version) Link
Windows, 64-bit (Qt5.1) CalcEnrichment-v1.0-win64.zip
Macintosh, 64-bit (Qt5.1) CalcEnrichment-v1.0-mac64.gz
Linux CentOS 5 , 64-bit (Qt4.7) CalcEnrichment-v1.0-linux-centos64.tar.gz