Mercurial > repos > bgruening > hicexplorer_hicmergematrixbins
annotate hicMergeMatrixBins.xml @ 4:8cad169bde4c draft
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 8def073a083b0619e366436a067a614555190058
author | iuc |
---|---|
date | Tue, 02 Jan 2018 10:15:37 -0500 |
parents | 5186eda61ca4 |
children | d04398893232 |
rev | line source |
---|---|
0
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
1 <tool id="hicexplorer_hicmergematrixbins" name="@BINARY@" version="@WRAPPER_VERSION@.0"> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
2 <description>Merges bins from a Hi-C matrix</description> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
3 <macros> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
4 <token name="@BINARY@">hicMergeMatrixBins</token> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
5 <import>macros.xml</import> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
6 </macros> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
7 <expand macro="requirements" /> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
8 <command detect_errors="exit_code"><![CDATA[ |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
9 hicMergeMatrixBins |
3
5186eda61ca4
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents:
2
diff
changeset
|
10 --matrix '$matrix_h5_cooler' |
0
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
11 --numBins $numBins |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
12 $runningWindow |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
13 --outFileName ./out.npz.h5 |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
14 |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
15 ]]> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
16 </command> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
17 <inputs> |
3
5186eda61ca4
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents:
2
diff
changeset
|
18 <expand macro='matrix_h5_cooler_macro' /> |
5186eda61ca4
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents:
2
diff
changeset
|
19 |
0
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
20 <param argument="--numBins" type="integer" min="1" value="3" label="Number of bins to merge" /> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
21 <param argument="--runningWindow" type="boolean" falsevalue="" truevalue="--runningWindow" label="Merge using a running window of length --numBins" /> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
22 </inputs> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
23 <outputs> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
24 <data name="outFileName" from_work_dir="out.npz.h5" format="h5"/> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
25 </outputs> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
26 <tests> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
27 <test> |
3
5186eda61ca4
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents:
2
diff
changeset
|
28 <param name="matrix_h5_cooler" value="small_test_matrix.h5"/> |
0
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
29 <param name="numBins" value="5" /> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
30 <output name="outFileName" file="hicMergeMatrixBins_result1.npz.h5" ftype="h5" compare="sim_size" delta="24000" /> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
31 </test> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
32 </tests> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
33 <help><![CDATA[ |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
34 |
2
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
35 Change matrix resolution |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
36 ======================== |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
37 |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
38 ``hicMergeMatrixBins`` is used to decrease the resolution of a matrix. With this tool you can create out of a 100 kb |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
39 contact matrix a 1000 kb one: |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
40 |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
41 Number of bins to merge = 10 |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
42 |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
43 100 kb * 10 = 1000 kb = 1 Mb |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
44 |
3
5186eda61ca4
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents:
2
diff
changeset
|
45 This functionality is useful especially for plotting. The higher the resolution of an contact matrix is, the more likely it is |
5186eda61ca4
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents:
2
diff
changeset
|
46 to run out of memory while plotting. This is caused by the circumstances that we compute internally with a sparse matrices but |
5186eda61ca4
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents:
2
diff
changeset
|
47 to plot we need a dense one. Furthermore, the higher the resolution of a matrix the more detailed it is which can make it |
5186eda61ca4
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents:
2
diff
changeset
|
48 difficult to interpret, especially if the read depth of the Hi-C data is not high. |
2
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
49 |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
50 Input |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
51 ----- |
0
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
52 |
2
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
53 Parameters |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
54 __________ |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
55 - contact matrix to change the resolution on |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
56 - Number of bins to merge |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
57 - running window |
0
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
58 |
2
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
59 Output |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
60 ------ |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
61 |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
62 A contact matrix with the resolution ``original resolution * number of bins``. |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
63 |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
64 | For more information about HiCExplorer please consider our documentation on readthedocs.io_ |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
65 |
cdff00acac0f
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents:
0
diff
changeset
|
66 .. _readthedocs.io: http://hicexplorer.readthedocs.io/en/latest/index.html |
0
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
67 ]]></help> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
68 <expand macro="citations" /> |
a1cf508bff84
planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents:
diff
changeset
|
69 </tool> |