comparison hicSumMatrices.xml @ 10:551510b684b7 draft

planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8

9:673c3280e576

<tool id="hicexplorer_hicsummatrices" name="@BINARY@" version="@WRAPPER_VERSION@.0">
    <description>combines Hi-C matrices of the same size</description>
    <macros>
        <token name="@BINARY@">hicSumMatrices</token>
        <import>macros.xml</import>
    </macros>
    <expand macro="requirements" />

        #set $m = '" "'.join([ '%s_matrix' % $counter for $counter, $matrix in enumerate($matrix_h5_cooler_multiple) ])

        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>
        </param>
    </inputs>

    </tests>
    <help><![CDATA[
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.

Input
-----

Parameters
__________
- two or matrices of the same shape.

Output
------
The summed matrix.

| For more information about HiCExplorer please consider our documentation on readthedocs.io_

.. _readthedocs.io: http://hicexplorer.readthedocs.io/en/latest/index.html
]]></help>

10:551510b684b7

<tool id="hicexplorer_hicsummatrices" name="@BINARY@" version="@WRAPPER_VERSION@.0">
    <description>combine Hi-C matrices of the same size</description>
    <macros>
        <token name="@BINARY@">hicSumMatrices</token>
        <import>macros.xml</import>
    </macros>
    <expand macro="requirements" />

        #set $m = '" "'.join([ '%s_matrix' % $counter for $counter, $matrix in enumerate($matrix_h5_cooler_multiple) ])

        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>
        </param>
    </inputs>

    </tests>
    <help><![CDATA[
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 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.

_________________

Usage
-----

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
------
**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_

.. _readthedocs.io: http://hicexplorer.readthedocs.io/en/latest/index.html
]]></help>