Mercurial > repos > bgruening > hicexplorer_hicsummatrices
diff hicSumMatrices.xml @ 9:0399cd2c25aa draft
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
author | iuc |
---|---|
date | Fri, 27 Apr 2018 03:31:58 -0400 |
parents | c109622e0cf5 |
children | e89bc5e38823 |
line wrap: on
line diff
--- a/hicSumMatrices.xml Wed Mar 07 03:27:10 2018 -0500 +++ b/hicSumMatrices.xml Fri Apr 27 03:31:58 2018 -0400 @@ -1,5 +1,5 @@ <tool id="hicexplorer_hicsummatrices" name="@BINARY@" version="@WRAPPER_VERSION@.0"> - <description>combines Hi-C matrices of the same size</description> + <description>combine Hi-C matrices of the same size</description> <macros> <token name="@BINARY@">hicSumMatrices</token> <import>macros.xml</import> @@ -15,13 +15,13 @@ hicSumMatrices --matrices "$m" --outFileName matrix.$outputFormat - + && mv matrix.$outputFormat matrix ]]> </command> <inputs> <expand macro='matrix_h5_cooler_multiple_macro'/> - + <param name='outputFormat' type='select' label="Output file format"> <option value='h5'>HiCExplorer format</option> <option value="cool">cool</option> @@ -46,23 +46,27 @@ Summation of matrices ===================== -``hicSumMatrix`` is combining two (or more) contact matrices of the same size to one. -This is useful if replicates of an Hi-C experiment should be merged into one contact matrix to -increase the power of the data. It is the nature of Hi-C that real contact cannot be distinguished -from noise, especially with a low contact count. The more contacts are given, the more likely it is -that a high number of contacts are real contact or contain at least a high amount. Therefore it is -a common way to merge replicates of Hi-C experiments to increase the validity of the experiment. +**hicSumMatrix** is combining two (or more) contact matrices of the same size to one. +This is useful if replicates of an Hi-C experiment should be merged into one contact matrix to +increase the coverage of the data. With Hi-C, real contacts are sometimes difficult to be distinguished +from noise, especially with a low contact count. The more contacts are given, the more likely it is +that a high number of contacts are biologically releveant. It is therefore common to merge biological +and technical replicates of Hi-C experiments and **hicSumMatrix** address this concern. -Input +_________________ + +Usage ----- -Parameters -__________ -- two or matrices of the same shape. +This tool takes two or more Hi-C contact matrices and sum the contacts into one matrix. It is recommended to use uncorrected and unmerged matrices as input (use the direct output from ``hicBuildMatrix``). Bin merging (``hicMergeMatrixBins``) and Hi-C contact matrix correction (``hicCorrectMatrix``) must be performed afterwards. + +_________________ Output ------ -The summed matrix. +**hicSumMatrix** outputs a Hi-C contact matrix comprising the sum of all the contacts of the Hi-C matrices used as input. + +_________________ | For more information about HiCExplorer please consider our documentation on readthedocs.io_