Skip to content

Commit 25d2dac

Browse files
authored
Update README.md
1 parent 68a472a commit 25d2dac

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,25 @@ When running `hicberg`, there are a handful parameters which are especially impo
6363
* `--start-stage`: Stage to start the pipeline (fastq, bam, groups, build, stats, rescue, final).
6464
* `--trim5`: Trim <int> bases from 5' (left) end of each read before alignment (default: 0).
6565

66+
67+
### Input Files
68+
69+
Input Hi-C data should be in paired-end data in fastq format. The fastq files can be given in compressed format like .gz.
70+
71+
The reference genome could be in fasta format or directy the index for bowtie2.
72+
73+
### Output Files
74+
Several files are generated by hicberg.
75+
* `unrescued.pairs.cool`: cool file of the Hi-C contact maps without hicberg reconstruction which correspond to what standard pipelines generate.
76+
* `rescued.pairs.cool`: cool file of the Hi-C contact maps with hicberg reconstruction.
77+
* if the option `-hcsp' is set to True, process from hicstuff https://github.com/koszullab/hicstuff are also applied like filtering of uncuts, recircularised events.., removal of duplicates. These files contained the extention .filtered (e.g: rescued.pairs.filtered.cool).
78+
79+
80+
81+
The cool format is an efficient and compact format for Hi-C data based on HDF5. It is maintained by the Mirny lab and documented here: https://open2c.github.io/cooler/
82+
For more informations, see the [cooler documentation](https://cooler.readthedocs.io/en/latest/cli.html#cooler-load)
83+
84+
6685
### <a id="contributing"></a> Contributing
6786

6887
All contributions are welcome, in the form of bug reports, suggestions, documentation or pull requests. We use the Numpy standard for docstrings when documenting functions.

0 commit comments

Comments
 (0)