Mercurial > repos > bgruening > hicexplorer_hiccorrelate

annotate hicCorrelate.xml @ 23:b3baeb3f8225 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 8586409c5f329eaf75902eedc3d29a6e82560788
author iuc
date Mon, 01 Jul 2024 18:51:02 +0000
parents d3911e6335cb
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
23
b3baeb3f8225 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 8586409c5f329eaf75902eedc3d29a6e82560788
iuc
parents: 22
diff changeset
1 <tool id="hicexplorer_hiccorrelate" name="@BINARY@" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
9
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
2 <description>compute pairwise correlations between multiple Hi-C contact matrices</description>
0
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
3 <macros>
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
4 <token name="@BINARY@">hicCorrelate</token>
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
5 <import>macros.xml</import>
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
6 </macros>
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
7 <expand macro="requirements" />
3
4ef71736c95a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
0
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
9
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
10 @multiple_input_matrices@
15
d4f02063593f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit fa19d3b6a9d0160a13f8d1e4a99f20c4dbe937b2"
iuc
parents: 14
diff changeset
11 @BINARY@
0
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
12
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
13 --matrices $matrices
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
14 --labels $mlabels
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
15
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
16 #if $method and $method is not None:
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
17 --method $method
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
18 #end if
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
19 $log1p
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
20
8
b10b77f55859 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 683d64a78adb3ff671f750d969d9daee5108169d
iuc
parents: 6
diff changeset
21 @USE_RANGE@
0
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
22
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
23 #if $chromosomes:
3
4ef71736c95a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
24 --chromosomes #echo "' '".join([ "'%s'" % $chrom.chromosome for $chrom in $chromosomes ])#
0
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
25 #end if
8
b10b77f55859 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 683d64a78adb3ff671f750d969d9daee5108169d
iuc
parents: 6
diff changeset
26
b10b77f55859 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 683d64a78adb3ff671f750d969d9daee5108169d
iuc
parents: 6
diff changeset
27 #if $colormap:
b10b77f55859 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 683d64a78adb3ff671f750d969d9daee5108169d
iuc
parents: 6
diff changeset
28 --colorMap $colormap
b10b77f55859 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 683d64a78adb3ff671f750d969d9daee5108169d
iuc
parents: 6
diff changeset
29 #end if
0
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
30
15
d4f02063593f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit fa19d3b6a9d0160a13f8d1e4a99f20c4dbe937b2"
iuc
parents: 14
diff changeset
31 --outFileNameHeatmap heatmap.png
d4f02063593f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit fa19d3b6a9d0160a13f8d1e4a99f20c4dbe937b2"
iuc
parents: 14
diff changeset
32 --outFileNameScatter scatter.png
0
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
33 ]]>
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
34 </command>
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
35 <inputs>
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
36 <expand macro="multiple_input_matrices" />
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
37
21
ec88fad8bc26 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 15
diff changeset
38 <param argument="--method" type="select" label="Correlation method to use">
0
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
39 <option value="spearman">Spearman</option>
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
40 <option selected="true" value="pearson">Pearson</option>
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
41 </param>
21
ec88fad8bc26 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 15
diff changeset
42 <param argument="--log1p" type="boolean" truevalue="--log1p" falsevalue="" label="Use the log1p of the matrix values" help="If set, then the log1p of the matrix values is used.
9
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
43 This parameter has no effect for Spearman correlations
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
44 but changes the output of Pearson correlation and, for
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
45 the scatter plot, if set, the visualization of the
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
46 values is easier." />
8
b10b77f55859 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 683d64a78adb3ff671f750d969d9daee5108169d
iuc
parents: 6
diff changeset
47
b10b77f55859 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 683d64a78adb3ff671f750d969d9daee5108169d
iuc
parents: 6
diff changeset
48 <expand macro="use_range" />
b10b77f55859 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 683d64a78adb3ff671f750d969d9daee5108169d
iuc
parents: 6
diff changeset
49
0
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
50 <repeat name="chromosomes" title="List of chromosomes to be included in the correlation" min="0">
23
b3baeb3f8225 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 8586409c5f329eaf75902eedc3d29a6e82560788
iuc
parents: 22
diff changeset
51 <param name="chromosome" type="text" label="chromosome (one per field)">
3
4ef71736c95a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
52 <validator type="empty_field" />
4ef71736c95a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
53 </param>
0
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
54 </repeat>
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
55 <expand macro="colormap" />
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
56 </inputs>
21
ec88fad8bc26 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 15
diff changeset
57 <outputs> <!-- not sure if argument is specifiable for output yet, would be cool if so -->
22
d3911e6335cb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit fa140a9f660eab2459e21b0b637b129d7de24c02
iuc
parents: 21
diff changeset
58 <data name="outFileNameHeatmap" from_work_dir="heatmap.png" format="png" label="${tool.name} on ${on_string}: Heatmap"/>
d3911e6335cb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit fa140a9f660eab2459e21b0b637b129d7de24c02
iuc
parents: 21
diff changeset
59 <data name="outFileNameScatter" from_work_dir="scatter.png" format="png" label="${tool.name} on ${on_string}: Scatter plot"/>
0
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
60 </outputs>
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
61 <tests>
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
62 <test>
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
63 <repeat name="input_files">
21
ec88fad8bc26 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 15
diff changeset
64 <param name="matrix" value="small_test_matrix.h5" ftype="h5" />
ec88fad8bc26 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 15
diff changeset
65 <param name="mlabel" value="first" />
0
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
66 </repeat>
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
67 <repeat name="input_files">
15
d4f02063593f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit fa19d3b6a9d0160a13f8d1e4a99f20c4dbe937b2"
iuc
parents: 14
diff changeset
68 <param name="matrix" value="small_test_matrix.h5" ftype="h5" />
21
ec88fad8bc26 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 15
diff changeset
69 <param name="mlabel" value="second" />
0
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
70 </repeat>
21
ec88fad8bc26 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 15
diff changeset
71 <param name="log1p" value="True" />
ec88fad8bc26 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 15
diff changeset
72 <param name="colormap" value="jet" />
ec88fad8bc26 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 15
diff changeset
73 <param name="method" value="spearman" />
ec88fad8bc26 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 15
diff changeset
74 <output name="outFileNameHeatmap" file="hicCorrelate_heatmap_result1.png" ftype="png" compare="sim_size" />
ec88fad8bc26 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 15
diff changeset
75 <output name="outFileNameScatter" file="hicCorrelate_scatter_result1.png" ftype="png" compare="sim_size" />
0
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
76 </test>
3
4ef71736c95a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
77 <test>
4ef71736c95a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
78 <repeat name="input_files">
21
ec88fad8bc26 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 15
diff changeset
79 <param name="matrix" value="small_test_matrix.h5" ftype="h5" />
ec88fad8bc26 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 15
diff changeset
80 <param name="mlabel" value="first" />
3
4ef71736c95a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
81 </repeat>
4ef71736c95a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
82 <repeat name="input_files">
15
d4f02063593f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit fa19d3b6a9d0160a13f8d1e4a99f20c4dbe937b2"
iuc
parents: 14
diff changeset
83 <param name="matrix" value="small_test_matrix.h5" ftype="h5" />
21
ec88fad8bc26 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 15
diff changeset
84 <param name="mlabel" value="second" />
3
4ef71736c95a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
85 </repeat>
8
b10b77f55859 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 683d64a78adb3ff671f750d969d9daee5108169d
iuc
parents: 6
diff changeset
86
21
ec88fad8bc26 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 15
diff changeset
87 <param name="log1p" value="True" />
ec88fad8bc26 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 15
diff changeset
88 <param name="colormap" value="jet" />
ec88fad8bc26 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 15
diff changeset
89 <param name="method" value="spearman" />
ec88fad8bc26 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 15
diff changeset
90 <output name="outFileNameHeatmap" file="hicCorrelate_heatmap_result1.png" ftype="png" compare="sim_size" />
ec88fad8bc26 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 15
diff changeset
91 <output name="outFileNameScatter" file="hicCorrelate_scatter_result1.png" ftype="png" compare="sim_size" />
3
4ef71736c95a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
92 </test>
0
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
93 </tests>
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
94 <help><![CDATA[
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
95
5
4a70b450b0af planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
96 Matrix correlation
4a70b450b0af planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
97 ==================
0
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
98
9
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
99 **hicCorrelate** is a dedicated Quality Control tool that allows the correlation of multiple Hi-C matrices at once with either a heatmap or scatterplots output.
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
100
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
101 Computes pairwise correlations between Hi-C matrices data. The correlation is computed taking the values from each pair of matrices and discarding values that are zero in both matrices. Parameters that strongly affect correlations are bin size of the Hi-C matrices (can be changed using ``hicMergeMatrixBins``) and the considered range. The smaller the bin size of the matrices, the finer the differences you score. The *Range* parameter should be selected at a meaningful genomic scale according to, for example, the mean size of the TADs in the organism you work with or to specific ranges found using ``hicPlotDistVsCounts``.
0
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
102
9
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
103 _________________
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
104
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
105 Usage
5
4a70b450b0af planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
106 -----
4a70b450b0af planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
107
9
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
108 It is recommended to use this tool on corrected matrices (``hicCorrectMatrix``) at restriction enzyme resolution (unmerged bins).
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
109
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
110 _________________
5
4a70b450b0af planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
111
4a70b450b0af planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
112 Output
4a70b450b0af planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
113 ------
4a70b450b0af planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
114
9
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
115 **hicCorrelate** outputs correlation plots of multiple Hi-C matrices.
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
116
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
117 Below, you can find a correlation example of uncorrected Hi-C matrices obtained from *Drosophila melanogaster* embryos, either wild-type or having one gene knocked-down by RNAi.
5
4a70b450b0af planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
118
9
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
119 Heatmap
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
120 _______
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
121
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
122 .. image:: $PATH_TO_IMAGES/hicCorrelate_Dmel_heatmap.png
5
4a70b450b0af planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
123 :width: 45%
4a70b450b0af planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
124
9
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
125 This example is showing a heatmap that was calculated using the Pearson correlation of corrected Hi-C matrices with a bin size of 6000 bp at a range of 5000 to 200000. The dendrogram indicates which samples are most similar to each other. You can see that the wild-type samples are seperated from the knock-down samples. In that case, Spearman correlation gives very similar results (not shown).
5
4a70b450b0af planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
126
9
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
127 Scatterplot
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
128 ___________
5
4a70b450b0af planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
129
9
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
130 .. image:: $PATH_TO_IMAGES/hicCorrelate_Dmel_scatterplot.png
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
131 :width: 45%
5
4a70b450b0af planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
132
9
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
133 Additionally, pairwise scatterplots comparing interactions between each sample can be plotted.
5
4a70b450b0af planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
134
9
ec90b407b6e7 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
135 _________________
5
4a70b450b0af planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
136
4a70b450b0af planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
137 For more information about HiCExplorer please consider our documentation on readthedocs.io_.
4a70b450b0af planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
138
4a70b450b0af planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
139 .. _readthedocs.io: http://hicexplorer.readthedocs.io/en/latest/index.html
4a70b450b0af planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
140 .. _Colormap: https://matplotlib.org/examples/color/colormaps_reference.html
0
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
141
21
ec88fad8bc26 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 15
diff changeset
142 ]]> </help>
0
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
143 <expand macro="citations" />
1b41da63ef0a planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
144 </tool>