This package is maintained by Caleb Lareau in the Aryee Lab. Source code is made freely available here and a packaged install version is provided through PyPi.
The hichipper package implements our data processing and quality control pipeline for
HiChIP data.
This package takes output from a HiC-Pro
run and a sample manifest file (.yaml)
that coordinates optional high-quality peaks (identified through ChIP-Seq) and
restriction fragment locations (see folder here)
as input and produces output that can be used to 1) determine library quality,
2) identify and characterize DNA loops and 3) interactively visualize loops.
Loops are assigned strength and confidence metrics that can be used to evaluate samples
individually or for differential analysis in
downstream tools like diffloop.
We have used the library QC metrics with as few as 1 million reads, enabling library quality to be assessed through shallow (and cheap) sequencing before performing a full depth sequencing run.
A graphical overview showing how hichipper integrates with other tools in the analysis of raw HiChIP data is shown in the overview figure below. Detailed descriptions of the different branches of input, output, and configuration for hichipper are discussed in the documentation.
Check out the hichipper documentation for detailed
installation instructions, dependency configuration, and other information regarding the tool and its implementation.
A simple graphical guide to processing HiChIP data is shown below. The role of hichipper
is to import aligned read files from (e.g. HiC-Pro)
as well as location of restriction fragment files
(available here) coordinated through a
.yaml configuration file and produce user-friendly output.
In particular, hichipper allows users to pre-supply their own set of gold-standard peaks (e.g. from ChIP-Seq) or call peaks directly from HiChIP data using a novel background detection algorithm. In either case, interactions and chromatin loops can be called using a restriction fragment-aware approach that substantially increases read density in loops.
In the qcReports folder, we collect the .html QC report files associated with text annotations
from the experiments performed in the original HiChIP manuscript
as well as other reports generated by anonymous collaborators that demonstrate libraries that did not prepare well, likely due
to poor in situ ligation. To determine the quality of a new HiChIP library, we recommend comparing the vital statistics and
interactive tables and figures between existing libraries.
If you use hichipper for your work, please cite:
Lareau, C.A. and Aryee, M.J. (2018) "hichipper: A preprocessing pipeline for assessing library quality and DNA loops from HiChIP data." bioRxiv doi: https://doi.org/10.1101/192302
are always welcomed. The easiest way for us to have correspondence (if appropriate/interesting
for the public) is through raising a new issue or our hichipper chat room on gitter.
Otherwise, email Caleb with any private concerns.
hichipper logo made with autowide font with these
blue and red
color definitions.