Skip to content
hanfeisun edited this page Apr 14, 2013 · 17 revisions

ChiLin is made to be easy. Follow the steps below for a quick start

Install ChiLin

Write conf

Let us copy and paste the following lines into a conf file, then save it (e.g. hello_chilin.conf).

[Basis]
id = 
species = 
factor = 
treat = 
control =
output = 

[lib]
genome_index = 
chrom_len = 
chrom_bed = 
gene_table = 
dhs = 
velcro = 
refgene = 
phast = 

Now you can edit this file and fill the value into the right side of =

Run ChiLin

After filling all the fields above, you can start running ChiLin now:

ChiLin2.py run -c hello_chilin.conf

Sandbox ChiLin

Green hand of ChiLin usually wants to try ChiLin in Sandbox mode before running. The Sandbox mode here means that ChiLin will output the information of whole workflow (every shell commands), but doesn't process these commands actually. In one word, it pretends to run ChiLin but doesn't run actually. Still confused? Just give it a try like this:

ChiLin2.py run -c hello_chilin.conf --dry-run

Customize ChiLin run

The workflow of ChiLin is consisted of the following steps:

  1. Groom Raw Sequencing Files
  2. Quality Control (QC) for Raw Sequencing Files using FastQC
  3. Library Contamination Detection
  4. Reads Mapping and QC using Bowtie
  5. Peak Calling and QC for datasets using MACS2
  6. Peak Calling and QC for replicates using MACS2
  7. Venn Diagram of peaks for replicates
  8. Correlation of Signals for replicates
  9. Overlapping of DnaseI Sensitive Sites (DHS) and QC
  10. Overlapping of velcro regions (blacklist) and QC
  11. Annotation Statistics using CEAS
  12. Conservation Statistics with PhastCons
  13. Motif Analysis using MDSeqPos

Sometimes you might want to skip a few unimportant steps, for example, skip Motif Analysis for a H3K4me3 data. Then you can do like this:

ChiLin2.py --run -c hello_chilin.conf --to 12

Or like this:

ChiLin2.py --run -c hello_chilin.conf --skip 13

The two commands are actually equivalent.

Customize ChiLin conf

To be continued