Skip to content

Commit a11d735

Browse files
author
nservant
committed
Update doc
1 parent 0115982 commit a11d735

File tree

2 files changed

+52
-43
lines changed

2 files changed

+52
-43
lines changed

README.rst

+52-19
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
.. Nicolas Servant
44
.. HiC-Pro
5-
.. v2.5.0
6-
.. 15-04-02
5+
.. v2.10.0
6+
.. 17-12-22
77
88
HiC-Pro Quick Start Guide
99
*************************
@@ -16,6 +16,10 @@ See LOGBOOK for details about the HiC-Pro developments
1616

1717
See LICENSE for license information
1818

19+
Where to find help ?
20+
====================
21+
22+
For any question about HiC-Pro, please contact [email protected] or use the `HiC-Pro forum <https://groups.google.com/forum/#!forum/hic-pro>`_ !
1923

2024
What is HiC-Pro ?
2125
=================
@@ -30,19 +34,17 @@ If you use HiC-Pro, please cite :
3034
HiC-Pro: An optimized and flexible pipeline for Hi-C processing. *Servant N., Varoquaux N., Lajoie BR., Viara E., Chen CJ., Vert JP., Dekker J., Heard E., Barillot E.* Genome Biology 2015, 16:259 doi:10.1186/s13059-015-0831-x
3135
`http://www.genomebiology.com/2015/16/1/259 <http://www.genomebiology.com/2015/16/1/259>`_
3236

33-
For any question about HiC-Pro, please contact [email protected] or use the `HiC-Pro forum <https://groups.google.com/forum/#!forum/hic-pro>`_ !
34-
3537
How to install it ?
3638
===================
3739

3840
The HiC-Pro pipeline requires the following dependencies :
3941

40-
* The `bowtie2 <http://bowtie-bio.sourceforge.net/bowtie2/index.shtml>`_ mapper
41-
* Python (>2.7) with *pysam (>=0.8.3)*, *bx-python(>=0.5.0)*, *numpy(>=1.8.2)*, and *scipy(>=0.15.1)* libraries
42-
* R with the *RColorBrewer* and *ggplot2* packages
43-
* g++ compiler
44-
* Samtools (>1.0)
45-
* Unix sort (which support -V option) is required ! For Mac OS user, please install the GNU core utilities !
42+
1. The `bowtie2 <http://bowtie-bio.sourceforge.net/bowtie2/index.shtml>`_ mapper
43+
2. Python (>2.7, python-3 is not supported) with *pysam (>=0.8.3)*, *bx-python(>=0.5.0)*, *numpy(>=1.8.2)*, and *scipy(>=0.15.1)* libraries
44+
3. R with the *RColorBrewer* and *ggplot2 (>2.2.1)* packages
45+
4. g++ compiler
46+
5. Samtools (>1.1)
47+
6. Unix sort (which support -V option) is required ! For Mac OS user, please install the GNU core utilities !
4648

4749
Bowtie >2.2.2 is strongly recommanded for allele specific analysis.
4850

@@ -92,7 +94,7 @@ Annotation Files
9294
In order to process the raw data, HiC-Pro requires three annotation files. Note that the pipeline is provided with some Human and Mouse annotation files.
9395
Please be sure that the chromosome names are the same than the ones used in your bowtie indexes !
9496

95-
1. **A BED file** of the restriction fragments after digestion. This file depends both of the restriction enzyme and the reference genome. See the :ref:`FAQ <FAQ>` and the :ref:`HiC-Pro utilities <UTILS>` for details about how to generate this file. A few annotation files are provided with the HiC-Pro sources.
97+
7. **A BED file** of the restriction fragments after digestion. This file depends both of the restriction enzyme and the reference genome. See the :ref:`FAQ <FAQ>` and the :ref:`HiC-Pro utilities <UTILS>` for details about how to generate this file. A few annotation files are provided with the HiC-Pro sources as examples.
9698

9799
::
98100

@@ -108,7 +110,7 @@ Please be sure that the chromosome names are the same than the ones used in your
108110
chr1 38791 39255 HIC_chr1_10 0 +
109111
(...)
110112

111-
2. **A table file** of chromosomes' size.
113+
8. **A table file** of chromosomes' size. This file can be easily find on the UCSC genome browser. Of note, pay attention to the contigs or scaffolds, and be aware that HiC-pro will generate a map per chromosome pair. For model organisms such as Human or Mouse, which are well annotated, we usually recommand to remove all scaffolds.
112114

113115
::
114116

@@ -124,20 +126,20 @@ Please be sure that the chromosome names are the same than the ones used in your
124126
chr10 135534747
125127
(...)
126128

127-
3. **The bowtie2 indexes**. See `the bowtie2 manual page <http://bowtie-bio.sourceforge.net/bowtie2/index.shtml>`_ for details about how to create such indexes.
129+
9. **The bowtie2 indexes**. See `the bowtie2 manual page <http://bowtie-bio.sourceforge.net/bowtie2/index.shtml>`_ for details about how to create such indexes.
128130

129131
How to use it ?
130132
===============
131133

132-
0. First have a look at the help message !
134+
10. First have a look at the help message !
133135

134136
.. code-block:: guess
135137
136138
HiC-Pro --help
137139
usage : HiC-Pro -i INPUT -o OUTPUT -c CONFIG [-s ANALYSIS_STEP] [-p] [-h] [-v]
138140
Use option -h|--help for more information
139141
140-
HiC-Pro 2.7.0
142+
HiC-Pro 2.10.0
141143
---------------
142144
OPTIONS
143145
@@ -154,22 +156,31 @@ How to use it ?
154156
[-h|--help]: help
155157
[-v|--version]: version
156158
157-
1. Copy and edit the configuration file *'config-hicpro.txt'* in your local folder. See the :ref:`manual <MANUAL>` for details about the configuration file
158-
2. Put all input files in a rawdata folder. The input files have to be organized with a folder per sample.
159+
11. Copy and edit the configuration file *'config-hicpro.txt'* in your local folder. See the :ref:`manual <MANUAL>` for details about the configuration file
160+
12. Put all input files in a rawdata folder. The input files have to be organized with one folder per sample, with ;
161+
* PATH_TO_MY_DATA
162+
* + sample1
163+
++ file1_R1.fastq.gz
164+
++ file1_R2.fastq.gz
165+
++ ...
166+
* + sample2
167+
++ file1_R1.fastq.gz
168+
++ file1_R2.fastq.gz
169+
*...
159170
3. Run HiC-Pro
160171
161172
* **On your laptop**
162173

163174
.. code-block:: guess
164175
165-
MY_INSTALL_PATH/bin/HiC-Pro -i FULL_PATH_TO_RAW_DATA -o FULL_PATH_TO_OUTPUTS -c MY_LOCAL_CONFIG_FILE
176+
MY_INSTALL_PATH/bin/HiC-Pro -i FULL_PATH_TO_DATA_FOLDER -o FULL_PATH_TO_OUTPUTS -c MY_LOCAL_CONFIG_FILE
166177
167178
168179
* **Using a cluster (TORQUE/SGE/SLURM/LSF)**
169180

170181
.. code-block:: guess
171182
172-
MY_INSTALL_PATH/bin/HiC-Pro -i FULL_PATH_TO_RAW_DATA -o FULL_PATH_TO_OUTPUTS -c MY_LOCAL_CONFIG_FILE -p
183+
MY_INSTALL_PATH/bin/HiC-Pro -i FULL_PATH_TO_DATA_FOLDER -o FULL_PATH_TO_OUTPUTS -c MY_LOCAL_CONFIG_FILE -p
173184
174185
175186
@@ -267,3 +278,25 @@ Small fastq files (2M reads) extracted from the Dixon et al. 2012 paper are avai
267278
user 3m24.493s
268279
sys 0m33.151s
269280
281+
282+
283+
Using HiC-Pro in a Singularity container
284+
========================================
285+
286+
HiC-Pro v2.10.0 provides a Singularity container to overcome any limitations with the installation process.
287+
288+
1- Install singularity
289+
http://singularity.lbl.gov/install-linux
290+
http://singularity.lbl.gov/install-mac
291+
http://singularity.lbl.gov/install-windows
292+
293+
2- Build the singularity HiC-Pro image
294+
295+
>> singularity create -s 5000 hicpro_ubuntu.img
296+
>> sudo singularity -d bootstrap hicpro_ubuntu.img hicpro_singularity
297+
298+
3- Run HiC-pro
299+
300+
>> singularity exec HiC-Pro -h
301+
302+

annotation/README

-24
This file was deleted.

0 commit comments

Comments
 (0)