runHiC
******
.. image:: https://zenodo.org/badge/doi/10.5281/zenodo.55324.svg
:target: http://dx.doi.org/10.5281/zenodo.55324
.. image:: https://static.pepy.tech/personalized-badge/runhic?period=total&units=international_system&left_color=black&right_color=orange&left_text=Downloads
:target: https://pepy.tech/project/runhic
runHiC is an easy-to-use command-line tool for Hi-C data processing.
Since version 0.8.6, runHiC has supported data from all kinds of 3C-based experiments,
including Hi-C, Micro-C, HiChIP/PLAC-Seq, and ChIA-PET. For experiments that do not use
restriction enzymes for DNA fragmentation, you can set the enzyme name arbitrarily for your
record. For example, for Micro-C, you can set it to *MNase*; for ChIA-PET, you can set it to
*sonication*.
Since version 0.8.5, runHiC has changed the default aligner to `chromap <https://github.com/haowenz/chromap>`_,
which is comparable to `bwa-mem <https://github.com/lh3/bwa>`_ in alignment accuracy, but runs over 10 times faster.
Since version 0.8.1, runHiC can be used directly on `Arima HiC <https://arimagenomics.com>`_ data
by setting the enzyme name to *Arima*.
Since version 0.8.0, runHiC has changed its default data container/format from HDF5 to
`Pairs <https://github.com/4dn-dcic/pairix/blob/master/pairs_format_specification.md>`_ and
`Cooler <https://github.com/mirnylab/cooler>`_.
Design Concepts
===============
runHiC is designed to process Hi-C data from raw sequencing reads(.sra, .fastq, .fastq.gz) to the ICE-corrected
contact matrices. It currently contains 5 subcommands:
+------------+-------------------------------------------------------------------------------------------------------------------+
| mapping | Map raw sequencing reads to a supplied genome. Support three read aligners: chromap, bwa and minimap2. |
+------------+-------------------------------------------------------------------------------------------------------------------+
| filtering | Perform read-level and fragment-level noise removing |
+------------+-------------------------------------------------------------------------------------------------------------------+
| binning | 1.Generate contact matirx; 2. Perform ICE/matrix-balancing normalization |
+------------+-------------------------------------------------------------------------------------------------------------------+
| pileup | Perform the entire processing steps from *mapping* to *binning* |
+------------+-------------------------------------------------------------------------------------------------------------------+
| quality | Evaluate the quality of your Hi-C data |
+------------+-------------------------------------------------------------------------------------------------------------------+
Links
=====
- `Detailed Documentation <http://xiaotaowang.github.io/HiC_pipeline/>`_
- `Installation <http://xiaotaowang.github.io/HiC_pipeline/install.html>`_
- `Quick Start <http://xiaotaowang.github.io/HiC_pipeline/quickstart.html>`_
- `Data Quality <http://xiaotaowang.github.io/HiC_pipeline/quality.html>`_
- `Parallel Computation <http://xiaotaowang.github.io/HiC_pipeline/parallel.html>`_
- `Code Repository <https://github.com/XiaoTaoWang/HiC_pipeline/>`_ (At GitHub, Track the package issue)
- `PyPI <https://pypi.python.org/pypi/runHiC>`_ (Download and Installation)
Usage
=====
Open a terminal, type ``runHiC -h`` or ``runHiC <subcommand> -h`` for help information.
Citation
========
Xiaotao Wang. (2016). runHiC: A user-friendly Hi-C data processing software based on hiclib. Zenodo.
`10.5281/zenodo.55324 <http://dx.doi.org/10.5281/zenodo.55324>`_
Raw data
{
"_id": null,
"home_page": "https://github.com/XiaoTaoWang/HiC_pipeline",
"name": "runHiC",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Hi-C Arima ICE cooler pairs bioinformatics pipeline",
"author": "XiaoTao Wang",
"author_email": "wangxiaotao686@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0f/11/98b832f144fb686bc4b9f09a6165090727c432ebfcdc324bcefac474fab2/runHiC-0.8.7.tar.gz",
"platform": null,
"description": "runHiC\n******\n.. image:: https://zenodo.org/badge/doi/10.5281/zenodo.55324.svg\n :target: http://dx.doi.org/10.5281/zenodo.55324\n.. image:: https://static.pepy.tech/personalized-badge/runhic?period=total&units=international_system&left_color=black&right_color=orange&left_text=Downloads\n :target: https://pepy.tech/project/runhic\n\nrunHiC is an easy-to-use command-line tool for Hi-C data processing.\n\nSince version 0.8.6, runHiC has supported data from all kinds of 3C-based experiments,\nincluding Hi-C, Micro-C, HiChIP/PLAC-Seq, and ChIA-PET. For experiments that do not use\nrestriction enzymes for DNA fragmentation, you can set the enzyme name arbitrarily for your\nrecord. For example, for Micro-C, you can set it to *MNase*; for ChIA-PET, you can set it to\n*sonication*.\n\nSince version 0.8.5, runHiC has changed the default aligner to `chromap <https://github.com/haowenz/chromap>`_,\nwhich is comparable to `bwa-mem <https://github.com/lh3/bwa>`_ in alignment accuracy, but runs over 10 times faster.\n\nSince version 0.8.1, runHiC can be used directly on `Arima HiC <https://arimagenomics.com>`_ data\nby setting the enzyme name to *Arima*.\n\nSince version 0.8.0, runHiC has changed its default data container/format from HDF5 to\n`Pairs <https://github.com/4dn-dcic/pairix/blob/master/pairs_format_specification.md>`_ and\n`Cooler <https://github.com/mirnylab/cooler>`_. \n\nDesign Concepts\n===============\nrunHiC is designed to process Hi-C data from raw sequencing reads(.sra, .fastq, .fastq.gz) to the ICE-corrected\ncontact matrices. It currently contains 5 subcommands:\n\n+------------+-------------------------------------------------------------------------------------------------------------------+\n| mapping | Map raw sequencing reads to a supplied genome. Support three read aligners: chromap, bwa and minimap2. |\n+------------+-------------------------------------------------------------------------------------------------------------------+\n| filtering | Perform read-level and fragment-level noise removing |\n+------------+-------------------------------------------------------------------------------------------------------------------+\n| binning | 1.Generate contact matirx; 2. Perform ICE/matrix-balancing normalization |\n+------------+-------------------------------------------------------------------------------------------------------------------+\n| pileup | Perform the entire processing steps from *mapping* to *binning* |\n+------------+-------------------------------------------------------------------------------------------------------------------+\n| quality | Evaluate the quality of your Hi-C data |\n+------------+-------------------------------------------------------------------------------------------------------------------+\n\nLinks\n=====\n- `Detailed Documentation <http://xiaotaowang.github.io/HiC_pipeline/>`_\n - `Installation <http://xiaotaowang.github.io/HiC_pipeline/install.html>`_\n - `Quick Start <http://xiaotaowang.github.io/HiC_pipeline/quickstart.html>`_\n - `Data Quality <http://xiaotaowang.github.io/HiC_pipeline/quality.html>`_\n - `Parallel Computation <http://xiaotaowang.github.io/HiC_pipeline/parallel.html>`_\n- `Code Repository <https://github.com/XiaoTaoWang/HiC_pipeline/>`_ (At GitHub, Track the package issue)\n- `PyPI <https://pypi.python.org/pypi/runHiC>`_ (Download and Installation)\n\nUsage\n=====\nOpen a terminal, type ``runHiC -h`` or ``runHiC <subcommand> -h`` for help information.\n\nCitation\n========\nXiaotao Wang. (2016). runHiC: A user-friendly Hi-C data processing software based on hiclib. Zenodo.\n`10.5281/zenodo.55324 <http://dx.doi.org/10.5281/zenodo.55324>`_\n",
"bugtrack_url": null,
"license": "",
"summary": "A easy-to-use Hi-C processing software supporting distributed computation",
"version": "0.8.7",
"split_keywords": [
"hi-c",
"arima",
"ice",
"cooler",
"pairs",
"bioinformatics",
"pipeline"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "93fdccb0534670e900c763d8ad020969437d175190e3f4f8ccf2a8985ad3590f",
"md5": "868c986230fa12e94bbbcf049f135bf3",
"sha256": "b5cba9fe1dea537c8e9691a5ff0674724790a87db8d38d89cb929296e4d954a4"
},
"downloads": -1,
"filename": "runHiC-0.8.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "868c986230fa12e94bbbcf049f135bf3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 39503,
"upload_time": "2023-01-19T06:19:59",
"upload_time_iso_8601": "2023-01-19T06:19:59.801380Z",
"url": "https://files.pythonhosted.org/packages/93/fd/ccb0534670e900c763d8ad020969437d175190e3f4f8ccf2a8985ad3590f/runHiC-0.8.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0f1198b832f144fb686bc4b9f09a6165090727c432ebfcdc324bcefac474fab2",
"md5": "d189e7b66a1bac9adab4154b92e8f260",
"sha256": "b813608b7cf94f37a83dc2543b9ec26441aa66e8e798061787cb08d8f2834646"
},
"downloads": -1,
"filename": "runHiC-0.8.7.tar.gz",
"has_sig": false,
"md5_digest": "d189e7b66a1bac9adab4154b92e8f260",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 38724,
"upload_time": "2023-01-19T06:20:01",
"upload_time_iso_8601": "2023-01-19T06:20:01.875311Z",
"url": "https://files.pythonhosted.org/packages/0f/11/98b832f144fb686bc4b9f09a6165090727c432ebfcdc324bcefac474fab2/runHiC-0.8.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-19 06:20:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "XiaoTaoWang",
"github_project": "HiC_pipeline",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "runhic"
}
JSON
