Mercurial > repos > bgruening > hicexplorer_hicmergematrixbins
diff hicMergeMatrixBins.xml @ 2:cdff00acac0f draft
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
author | iuc |
---|---|
date | Sat, 16 Dec 2017 16:33:36 -0500 |
parents | a1cf508bff84 |
children | 5186eda61ca4 |
line wrap: on
line diff
--- a/hicMergeMatrixBins.xml Mon Nov 27 11:13:54 2017 -0500 +++ b/hicMergeMatrixBins.xml Sat Dec 16 16:33:36 2017 -0500 @@ -34,10 +34,35 @@ </tests> <help><![CDATA[ -**What it does** +Change matrix resolution +======================== + +``hicMergeMatrixBins`` is used to decrease the resolution of a matrix. With this tool you can create out of a 100 kb +contact matrix a 1000 kb one: + +Number of bins to merge = 10 + +100 kb * 10 = 1000 kb = 1 Mb + +This functionality is useful especially for plotting. The higher the resolution of an contact matrix is, the more likely it is to run out of memory while plotting. This is caused by the circumstances that we compute internally with a sparse matrices but to plot we need a dense one. Furthermore, the higher the resolution of a matrix the more detailed it is which can make it difficult to interpret, especially if the read depth of the Hi-C data is not high. + +Input +----- -Merges neighboring bins in a Hi-C matrix. +Parameters +__________ +- contact matrix to change the resolution on +- Number of bins to merge +- running window +Output +------ + +A contact matrix with the resolution ``original resolution * number of bins``. + +| For more information about HiCExplorer please consider our documentation on readthedocs.io_ + +.. _readthedocs.io: http://hicexplorer.readthedocs.io/en/latest/index.html ]]></help> <expand macro="citations" /> </tool>