Skip to main content

HiCLift

With the continuous effort to improve the quality of human reference genome and the generation of more and more personal genomes, the conversion of genomic coordinates between genome assemblies is critical in many integrative and comparative studies. While tools have been developed for such task for linear genome signals such as ChIP-Seq, no tool exists to convert genome assemblies for chromatin interaction data, despite the importance of three-dimensional (3D) genome organization in gene regulation and disease. Here, we present HiCLift (previously known as pairLiftOver), a fast and efficient tool that can convert the genomic coordinates of chromatin contacts such as Hi-C and Micro-C from one assembly to another, including the latest T2T genome. Comparing with the strategy of directly re-mapping raw reads to a different genome, HiCLift runs on average 42 times faster (hours vs. days), while outputs nearly identical contact matrices. More importantly, as HiCLift does not need to re-map the raw reads, it can directly convert human patient sample data, where the raw sequencing reads are sometimes hard to acquire or not available.

Installation

HiCLift and all the dependencies can be installed through either mamba or pip:

$ conda config --append channels defaults
$ conda config --append channels bioconda
$ conda config --append channels conda-forge
$ mamba create -n HiCLift cooler pairtools kerneltree cxx-compiler
$ mamba activate HiCLift
$ pip install HiCLift hic-straw

Overview

The inputs to HiCLift include two parts. The first part is a file containing the chromatin contacts information. This file can be either a pairs file (4DN pairs or HiC-Pro allValidPairs) with each row representing a pair of interacting genomic loci in base-pair resolution, or a matrix file (.cool or .hic), which stores interaction frequencies between genomic intervals of fixed size. The second part is a UCSC chain file, which describes pairwise alignment that allows gaps in both assemblies simultaneously. Internally, HiCLift represents a chain file as IntervalTrees, with one tree per chromosome, to efficiently search for a specific genomic position in a chain file and locate the matched position in the target genome. The converted chromatin contacts will be reported in either a sorted 4DN pairs file, which can be directly used to generate contact matrix in various formats, or a matrix file in .cool or .hic formats.

./images/fig1.svg.png

Usage

Open a terminal, type HiCLift -h for help information.

Here is an example command which uses a 4DN pairs file in hg19 coordinates as input, and outputs an mcool file with chromatin contacts in hg38 coordinates:

$ HiCLift --input test.hg19.pairs.gz --input-format pairs --out-pre test-hg38 \
--output-format cool --out-chromsizes hg38.chrom.sizes --in-assembly hg19 --out-assembly hg38 \
--logFile HiCLift.log

HiCLift can also serve as a tool to perform a pure data format conversion. For example, the following command transforms a contact matrix from the .cool format to the .hic format, without the coordinate liftover. Note that the values of --in-assembly and --out-assembly need to be the same to turn on this function:

$ HiCLift --input Rao2014-K562-MboI-allreps-filtered.5kb.cool --input-format cooler \
--out-pre K562-format-conversion-test --output-format hic --out-chromsizes hg19.chrom.sizes \
--in-assembly hg19 --out-assembly hg19 --memory 40G

Performance

Using large Hi-C datasets of different species as a benchmark, we show that compared with the strategy directly re-mapping raw reads to a different genome, HiCLift runs on average 42 times faster, while outputs nearly identical contact matrices.

./images/accuracy.png

Metadata

Release files for HiCLift 1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for HiCLift 1.0
File Size Uploaded
HiCLift-1.0.tar.gz 27.7 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for HiCLift 1.0
File Interpreter ABI Platform
HiCLift-1.0-py3-none-any.whl Python 3 none any Details

Total release size: 55.5 MB

Release files / HiCLift-1.0.tar.gz

Download URL HiCLift-1.0.tar.gz
Size 27.7 MB
Tags Source
SHA-256 checksum
How to use checksums
3573dc51894b1c9a44fcc448896912864fb7288d37ec5a5a861a756d10be1b0c
BLAKE2b-256 checksum
How to use checksums
7ef87aff3c8913e3e127c23aaca6609caa079f15bd131b842c61ff69ab2eeb8a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.8

Release files / HiCLift-1.0-py3-none-any.whl

Download URL HiCLift-1.0-py3-none-any.whl
Size 27.8 MB
Tags Python 3
SHA-256 checksum
How to use checksums
f9b72937565cac586b3baed7504135a193ce57cfa76830997e8464e32848662a
BLAKE2b-256 checksum
How to use checksums
420907c3158339644b06d0fcf269477a8e1b5f19af1e7742c9f90fa97c344325
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.8

Release history Release notifications | RSS feed

This release

1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page