Skip to main content

Set of programs to process, analyze and visualize Hi-C data

Project description

.. image:: https://travis-ci.org/deeptools/HiCExplorer.svg?branch=master
:target: https://travis-ci.org/deeptools/HiCExplorer
.. image:: https://readthedocs.org/projects/hicexplorer/badge/?version=latest
:target: http://hicexplorer.readthedocs.io/?badge=latest
.. image:: https://anaconda.org/bioconda/hicexplorer/badges/installer/conda.svg
:target: https://anaconda.org/bioconda/hicexplorer
.. image:: https://quay.io/repository/biocontainers/hicexplorer/status
:target: https://quay.io/repository/biocontainers/hicexplorer
.. image:: https://badge.fury.io/py/HiCExplorer.svg
:target: https://badge.fury.io/py/HiCExplorer

HiCExplorer
===========

Set of programs to process, analyze and visualize Hi-C data
-----------------------------------------------------------

Sequencing techniques that probe the 3D organization of the genome generate large amounts of data whose processing,
analysis and visualization is challenging. Here, we present HiCExplorer, a set of tools for the analysis and
visualization of chromosome conformation data. HiCExplorer facilitates the creation of contact matrices, correction
of contacts, TAD detection, A/B compartments, merging, reordering or chromosomes, conversion from different formats including
`cooler <https://github.com/mirnylab/cooler>`_ and detection of long-range contacts. Moreover, it allows the visualization of
multiple contact matrices along with other types of data like genes, compartments, ChIP-seq coverage tracks (and in general
any type of genomic scores), long range contacts and the visualization of viewpoints.


Citation:
^^^^^^^^^


Fidel Ramirez, Vivek Bhardwaj, Jose Villaveces, Laura Arrigoni, Bjoern A Gruening, Kin Chung Lam, Bianca Habermann, Asifa Akhtar, Thomas Manke.
**"High-resolution TADs reveal DNA sequences underlying genome organization in flies". Nature Communications**, Volume 9, Article number: 189 (2018), doi: https://doi.org/10.1038/s41467-017-02525-w

Joachim Wolff, Vivek Bhardwaj, Stephan Nothjunge, Gautier Richard, Gina Renschler, Ralf Gilsbach, Thomas Manke, Rolf Backofen, Fidel Ramírez, Björn A Grüning.
**"Galaxy HiCExplorer: a web server for reproducible Hi-C data analysis, quality control and visualization", Nucleic Acids Research**, Volume 46, Issue W1, 2 July 2018, Pages W11–W16, doi: https://doi.org/10.1093/nar/gky504

.. image:: ./docs/images/hicex2.png

Availability
^^^^^^^^^^^^

HiCExplorer is available as a **command line suite of tools** on this very GitHub repository and also on other platforms (detailed in *Installation* below).

A **Galaxy HiCExplorer version** is directly available to users at http://hicexplorer.usegalaxy.eu. Training material is available at the `Galaxy Training Network <http://galaxyproject.github.io/training-material/topics/epigenetics/tutorials/hicexplorer/tutorial.html>`_,
while a Galaxy Tour is available `here <https://hicexplorer.usegalaxy.eu/tours/hixexplorer>`_ for users not familiar with this platform. Galaxy HiCExplorer is also available as a Docker image at the `Docker Galaxy HiCExplorer GitHub repository <https://github.com/deeptools/docker-galaxy-hicexplorer>`_. Finally, this Galaxy version is available on the `Galaxy Tool Shed <https://toolshed.g2.bx.psu.edu/>`_ and on the corresponding `GitHub repository <https://github.com/galaxyproject/tools-iuc>`_.


Installation
^^^^^^^^^^^^

With version 2.0, HiCExplorer is available for Python 2 and Python 3 and can be installed via:

- Pip, Anaconda and GitHub for command line usage.
- Toolshed and Docker image for its integration on Galaxy servers.

There are many easy ways to install HiCExplorer. Details can be found
`here <https://hicexplorer.readthedocs.io/en/latest/content/installation.html>`_.

Command line version
++++++++++++++++++++

Install with conda
__________________

The easiest way to install HiCExplorer is using `BioConda <http://bioconda.github.io/>`_
::

$ conda install hicexplorer -c bioconda -c conda-forge

Install with pip
________________
::

$ pip install HiCExplorer

Install by cloning this repository
__________________________________

You can install any one of the HiCExplorer branches on command line
(linux/mac) by cloning this git repository :

::

$ git clone https://github.com/deeptools/HiCExplorer.git
$ cd HiCExplorer
$ python setup.py install

If you don't have root permission, you can set a specific folder using the ``--prefix`` option

::

$ python setup.py install --prefix /User/Tools/hicexplorer

Galaxy version
++++++++++++++

Install with Docker
___________________

Installation instructions as a Docker image can be followed at https://github.com/deeptools/docker-galaxy-hicexplorer.


Install with Tool Shed
______________________

Galaxy HiCExplorer is part of the `Galaxy Tool Shed <https://toolshed.g2.bx.psu.edu/>`_ and can be installed from there to any Galaxy server following `this link <https://toolshed.g2.bx.psu.edu/repository/browse_repository?id=f1554978eeb3da8b>`_.


Documentation:
^^^^^^^^^^^^^^
Please visit our complete documentation `Here <http://hicexplorer.readthedocs.org/>`_. This documentation is also available directly within `Galaxy <http://hicexplorer.usegalaxy.eu/>`_.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

HiCExplorer-2.2.1.1-py3-none-any.whl (199.5 kB view details)

Uploaded Python 3

HiCExplorer-2.2.1.1-py2-none-any.whl (197.3 kB view details)

Uploaded Python 2

File details

Details for the file HiCExplorer-2.2.1.1-py3-none-any.whl.

File metadata

  • Download URL: HiCExplorer-2.2.1.1-py3-none-any.whl
  • Upload date:
  • Size: 199.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.7.0 requests-toolbelt/0.8.0 tqdm/4.31.1 CPython/2.7.15

File hashes

Hashes for HiCExplorer-2.2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 128b64d6d1634e0826cb3dcfc662468d2a880ed2f24ccdda3bff7a6ed376b89c
MD5 0747df9da5e7dfbac8feae457a6e07af
BLAKE2b-256 280f271eb6ec4faf5cf880dc0a947e02476c4d600646f9e14dfb7d9002fa8d0a

See more details on using hashes here.

Provenance

File details

Details for the file HiCExplorer-2.2.1.1-py2-none-any.whl.

File metadata

  • Download URL: HiCExplorer-2.2.1.1-py2-none-any.whl
  • Upload date:
  • Size: 197.3 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.7.0 requests-toolbelt/0.8.0 tqdm/4.31.1 CPython/2.7.15

File hashes

Hashes for HiCExplorer-2.2.1.1-py2-none-any.whl
Algorithm Hash digest
SHA256 30ec9606f47c8e356be7c9d7a01691775367a5a063f4c6b43f84652ea37f694d
MD5 cc458d47f54cf618a774d8c3fb48e6cd
BLAKE2b-256 1f3e44e2fa472443d2e17e5939e4160948ce2b2fa7b2fd8d0ee69ce297f7cda9

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page