annotate hicSumMatrices.xml @ 5:b9f41afc3312 draft

planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
author bgruening
date Sat, 30 Dec 2017 09:36:36 -0500
parents d387dacb6867
children e0df60f3b0d5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
1 <tool id="hicexplorer_hicsummatrices" name="@BINARY@" version="@WRAPPER_VERSION@.0">
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
2 <description>combines Hi-C matrices of the same size</description>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
3 <macros>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
4 <token name="@BINARY@">hicSumMatrices</token>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
5 <import>macros.xml</import>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
6 </macros>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
7 <expand macro="requirements" />
2
2bbe234ca6ce planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
2bbe234ca6ce planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
9
5
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
10 #for $counter, $m in enumerate($matrix_h5_cooler_multiple):
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
11 ln -s '$m' ${counter}_matrix &&
0
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
12 #end for
5
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
13 #set $m = '" "'.join([ '%s_matrix' % $counter for $counter, $matrix in enumerate($matrix_h5_cooler_multiple) ])
0
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
14
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
15 hicSumMatrices
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
16 --matrices "$m"
5
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
17 #if $outputFormat == 'h5'
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
18 --outFileName matrix.h5
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
19 #elif $outputFormat == 'cool'
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
20 --outFileName matrix.cool
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
21 #end if
0
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
22 ]]>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
23 </command>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
24 <inputs>
5
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
25 <expand macro='matrix_h5_cooler_multiple_macro'/>
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
26
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
27 <param name='outputFormat' type='select' label="Output file format">
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
28 <option value='h5'>HiCExplorer format</option>
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
29 <option value="cool">cool</option>
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
30 </param>
0
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
31 </inputs>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
32 <outputs>
5
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
33 <data name="outFileName_h5" from_work_dir="matrix.h5" format="h5">
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
34 <filter>outputFormat == 'h5'</filter>
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
35 </data>
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
36 <data name="outFileName_cool" from_work_dir="matrix.cool" format="cool">
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
37 <filter>outputFormat == 'cool'</filter>
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
38 </data>
0
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
39 </outputs>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
40 <tests>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
41 <test>
5
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
42 <param name="matrix_h5_cooler_multiple" value="hicCorrectMatrix_result1.npz.h5,hicCorrectMatrix_result1.npz.h5"/>
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
43 <!-- <param name="matrices" value="hicCorrectMatrix_result1.npz.h5,hicCorrectMatrix_result1.npz.h5"/> -->
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
44 <param name='outputFormat' value='h5'/>
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
45 <output name="outFileName_h5" file="hicSumMatrices_result1.npz.h5" ftype="h5" compare="sim_size" delta="70000"/>
0
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
46 </test>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
47 </tests>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
48 <help><![CDATA[
4
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
49 Summation of matrices
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
50 =====================
0
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
51
4
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
52 ``hicSumMatrix`` is combining two (or more) contact matrices of the same size to one.
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
53 This is useful if replicates of an Hi-C experiment should be merged into one contact matrix to
5
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
54 increase the power of the data. It is the nature of Hi-C that real contact cannot be distinguished
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
55 from noise, especially with a low contact count. The more contacts are given, the more likely it is
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
56 that a high number of contacts are real contact or contain at least a high amount. Therefore it is
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
57 a common way to merge replicates of Hi-C experiments to increase the validity of the experiment.
0
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
58
4
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
59 Input
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
60 -----
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
61
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
62 Parameters
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
63 __________
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
64 - two or matrices of the same shape.
0
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
65
4
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
66 Output
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
67 ------
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
68 The summed matrix.
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
69
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
70 | For more information about HiCExplorer please consider our documentation on readthedocs.io_
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
71
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
72 .. _readthedocs.io: http://hicexplorer.readthedocs.io/en/latest/index.html
0
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
73 ]]></help>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
74 <expand macro="citations" />
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
75 </tool>