Skip to content

Commit

Permalink
added faq with HiCMatrix 12 to 13
Browse files Browse the repository at this point in the history
  • Loading branch information
lldelisle committed May 15, 2020
1 parent 7065bdb commit 35f3d0c
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
15 changes: 15 additions & 0 deletions docs/content/faq.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
FAQ
===

.. contents::
:local:

Why the scale of my Hi-C plot suddenly changed
----------------------------------------------
pyGenomeTracks is using `HiCMatrix <https://github.com/deeptools/HiCMatrix>`_ to read the matrix from ``h5`` and ``cool`` format.
From version 12 to version 13, a normalization step when reading ``cool`` file was removed. This normalization was mostly used
when you were providing ``cool`` file from `cooler balance <https://cooler.readthedocs.io/en/latest/cli.html#cooler-balance>`_.

If you want to keep the old scale you need to downgrade to HiCMatrix version 12 but version 13 also correct some bugs so we advice
to change your ``max_value`` in your parameter file to adjust to the new scale.

2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ Table of content
content/possible-parameters
content/adding-new-tracks
content/releases

content/faq

0 comments on commit 35f3d0c

Please sign in to comment.