Mercurial > repos > bgruening > hicexplorer_hicsummatrices

annotate hicSumMatrices.xml @ 10:43acab7077db draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dddc0b9035b8edadfd45d74b01aeca245c2725d7
author iuc
date Fri, 27 Apr 2018 08:40:09 -0400
parents 0399cd2c25aa
children e89bc5e38823
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
c109622e0cf5 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
iuc
parents: 7
diff changeset
1 <tool id="hicexplorer_hicsummatrices" name="@BINARY@" version="@WRAPPER_VERSION@.0">
9
0399cd2c25aa planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
2 <description>combine Hi-C matrices of the same size</description>
0
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
8
c109622e0cf5 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
iuc
parents: 7
diff changeset
10 #for $counter, $m in enumerate($matrix_h5_cooler_multiple):
5
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"
7
e0df60f3b0d5 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit d76f2040a05a5f8752cbfe9a8bc1ef9efae45c01
iuc
parents: 5
diff changeset
17 --outFileName matrix.$outputFormat
9
0399cd2c25aa planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
18
7
e0df60f3b0d5 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit d76f2040a05a5f8752cbfe9a8bc1ef9efae45c01
iuc
parents: 5
diff changeset
19 && mv matrix.$outputFormat matrix
0
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
20 ]]>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
21 </command>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
22 <inputs>
5
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
23 <expand macro='matrix_h5_cooler_multiple_macro'/>
9
0399cd2c25aa planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
24
5
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
25 <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
26 <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
27 <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
28 </param>
0
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
29 </inputs>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
30 <outputs>
7
e0df60f3b0d5 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit d76f2040a05a5f8752cbfe9a8bc1ef9efae45c01
iuc
parents: 5
diff changeset
31 <data name="outFileName" from_work_dir="matrix" format="h5">
e0df60f3b0d5 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit d76f2040a05a5f8752cbfe9a8bc1ef9efae45c01
iuc
parents: 5
diff changeset
32 <change_format>
e0df60f3b0d5 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit d76f2040a05a5f8752cbfe9a8bc1ef9efae45c01
iuc
parents: 5
diff changeset
33 <when input="outputFormat" value="cool" format="cool" />
e0df60f3b0d5 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit d76f2040a05a5f8752cbfe9a8bc1ef9efae45c01
iuc
parents: 5
diff changeset
34 </change_format>
5
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
35 </data>
0
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
36 </outputs>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
37 <tests>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
38 <test>
5
b9f41afc3312 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
39 <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
40 <!-- <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
41 <param name='outputFormat' value='h5'/>
7
e0df60f3b0d5 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit d76f2040a05a5f8752cbfe9a8bc1ef9efae45c01
iuc
parents: 5
diff changeset
42 <output name="outFileName" 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
43 </test>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
44 </tests>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
45 <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
46 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
47 =====================
0
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
48
9
0399cd2c25aa planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
49 **hicSumMatrix** is combining two (or more) contact matrices of the same size to one.
0399cd2c25aa planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
50 This is useful if replicates of an Hi-C experiment should be merged into one contact matrix to
0399cd2c25aa planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
51 increase the coverage of the data. With Hi-C, real contacts are sometimes difficult to be distinguished
0399cd2c25aa planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
52 from noise, especially with a low contact count. The more contacts are given, the more likely it is
0399cd2c25aa planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
53 that a high number of contacts are biologically releveant. It is therefore common to merge biological
0399cd2c25aa planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
54 and technical replicates of Hi-C experiments and **hicSumMatrix** address this concern.
0
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
55
9
0399cd2c25aa planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
56 _________________
0399cd2c25aa planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
57
0399cd2c25aa planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
58 Usage
4
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
59 -----
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
60
9
0399cd2c25aa planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
61 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.
0399cd2c25aa planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
62
0399cd2c25aa planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
63 _________________
0
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
64
4
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
65 Output
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
66 ------
9
0399cd2c25aa planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
67 **hicSumMatrix** outputs a Hi-C contact matrix comprising the sum of all the contacts of the Hi-C matrices used as input.
0399cd2c25aa planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
68
0399cd2c25aa planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
69 _________________
4
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
70
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
71 | 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
72
d387dacb6867 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 2
diff changeset
73 .. _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
74 ]]></help>
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
75 <expand macro="citations" />
c4ee66c35eb6 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
76 </tool>