view hicCompareMatrices.xml @ 0:a0ab04565c73 draft

planemo upload for repository commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
author bgruening
date Wed, 07 Mar 2018 03:37:57 -0500
children 08e157ceda6f
line wrap: on
line source

<tool id="hicexplorer_hiccomparematrices" name="@BINARY@" version="@WRAPPER_VERSION@.0">
    <description>normalize and compare two HiC matricies</description>
        <token name="@BINARY@">hicCompareMatrices</token>
    <expand macro="requirements" />
    <command detect_errors="exit_code"><![CDATA[

    --matrices '$matrix1' '$matrix2'
    --operation $operation
    --outFileName matrix.$outputFormat

    && mv matrix.$outputFormat matrix
        <param name='matrix1' type="data" format="h5,cool"
            label="First matrix"/>
        <param name='matrix2' type="data" format="h5,cool"
            label="Second matrix to compare against the first"/>

        <param name='operation' type='select' label="Operation to be used for the comparison">
            <option value='diff'>diff</option>
            <option value="ratio">ratio</option>
            <option value="log2ratio">log2ratio</option>
        <param name='outputFormat' type='select' label="Output file format">
            <option value='h5'>HiCExplorer format</option>
            <option value="cool">cool</option>
        <data name="outFileName" from_work_dir="matrix" format="h5" label="${} MATRIX on ${on_string}">
                <when input="outputFormat" value="cool" format="cool" />
            <param name="matrix1" value="small_test_matrix.h5"/>
            <param name="matrix2" value="small_test_matrix.h5"/>
            <param name="operation" value='log2ratio' />
            <param name="outputFormat" value="h5" />
            <output name="outFileName" file="compare_matrices_log2ratio.h5" ftype="h5" compare="sim_size" delta='2000'/>
            <param name="matrix1" value=""/>
            <param name="matrix2" value=""/>
            <param name="operation" value='ratio' />
            <param name="outputFormat" value="cool" />
            <output name="outFileName" file="" ftype="cool" compare="sim_size" delta='2000'/>

Comparison of HiC matrices
`hicCompareMatrices` takes two matrices, normalizes them and appliesthe given operation. To
normalize the matrices each element is divided by sum of the matrix.

- the matricies to be compared

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

    <expand macro="citations" />