annotate hicAggregateContacts.xml @ 1:a49b7fad9421 draft

planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
author iuc
date Sat, 09 Jun 2018 15:24:50 -0400
parents 44049472de9e
children 14e99c3f54fe
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
1
0
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
2 <tool id="hicexplorer_hicaggregatecontacts" name="@BINARY@" version="@WRAPPER_VERSION@.0">
1
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
3 <description>allow plotting of aggregated Hi-C contacts between regions specified in a file</description>
0
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
4 <macros>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
5 <token name="@BINARY@">hicAggregateContacts</token>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
6 <import>macros.xml</import>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
7 </macros>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
8 <expand macro="requirements" />
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
9 <command detect_errors="exit_code"><![CDATA[
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
10 @BINARY@
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
11 --matrix '$matrix_h5_cooler'
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
12 --BED $BED
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
13 #if $BED2:
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
14 --BED2 $BED2
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
15 #end if
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
16
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
17 --range $range_min:$range_max
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
18
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
19 --numberOfBins $numberOfBins
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
20
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
21 --transform $transform
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
22 --avgType $avgType
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
23
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
24 #if $outputs and 'PrefixMatrix' in $outputs:
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
25 --outFilePrefixMatrix 'matrix_values'
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
26 #end if
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
27
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
28 #if $outputs and 'ClusterContactPositions' in $outputs:
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
29 --outFilePrefixClusterContactPositions 'contact_positions'
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
30 #end if
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
31
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
32 #if $outputs and 'HeatmapFile' in $outputs:
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
33 --diagnosticHeatmapFile 'heatmap'
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
34 #end if
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
35
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
36 #if $clustering:
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
37 $clustering
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
38 #end if
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
39 $clusterOnDiagonal
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
40
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
41 #if $chromosomes:
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
42 --chromosomes #echo "' '".join([ "'%s'" % $chrom.chromosome for $chrom in $chromosomes ])#
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
43 #end if
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
44
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
45 #if $plotType:
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
46 --plotType $plotType
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
47 #end if
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
48
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
49 #if $colormap:
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
50 --colorMap $colormap
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
51 #end if
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
52
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
53 #if $vMin:
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
54 --vMin $vMin
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
55 #end if
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
56
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
57 #if $vMax:
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
58 --vMax $vMax
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
59 #end if
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
60
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
61 --outFileName plot.$image_file_format
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
62 && mv plot.$image_file_format plot
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
63
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
64 ]]>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
65 </command>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
66 <inputs>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
67 <expand macro='matrix_h5_cooler_macro' />
1
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
68 <param argument="--BED" type="data" format="bed" label="Interactions between regions in this BED file are plotted"/>
0
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
69 <param argument="--BED2" type="data" format="bed" optional="true"
1
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
70 label="Interactions between regions in first and second BED file are plotted"/>
0
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
71
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
72 <expand macro='range' />
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
73
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
74 <repeat name="chromosomes" title="List of chromosomes to plot" min="0">
1
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
75 <param name="chromosome" type="text" label="chromosome (one per field)">
0
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
76 <validator type="empty_field" />
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
77 </param>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
78 </repeat>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
79
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
80 <param argument="--numberOfBins" type="integer" optional="true" label="Number of bins to include in the submatrix"
1
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
81 help="The bed regions will be centered between -half number of bins
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
82 and +half number of bins indicated." />
0
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
83
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
84 <param argument="--transform" type="select" label="Type of transformation for the matrix"
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
85 help="If total counts are selected, then the sub-matrix values
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
86 are divided by the total counts for normalization. If
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
87 z-score or obs/exp are selected, then H-C matrix is
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
88 converted into a z-score or observed / expected matrix.">
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
89 <option value="none" selected="true">none</option>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
90 <option value="total-counts">total-counts</option>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
91 <option value="z-score">z-score</option>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
92 <option value="obs/exp">obs/exp</option>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
93 </param>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
94
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
95 <param argument="--avgType" type="select" label="Type of average to compute final matrix">
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
96 <option value="median" selected="true">median</option>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
97 <option value="mean">mean</option>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
98 </param>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
99
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
100 <param name="clustering" type="select" optional="true" label="Number of clusters per chromosome"
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
101 help="When this option is set, then the matrix is split into
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
102 clusters using the hierarchical clustering algorithm,
1
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
103 using 'ward linkage'. hclust could be very slow if
0
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
104 you have >1000 submatrices per chromosome. In those
1
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
105 cases, you might prefer kmeans.">
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
106 <option value="--kmeans">kmeans</option>
0
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
107 <option value="--hclust">hclust (#clusters per chromosome)</option>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
108 </param>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
109
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
110 <param argument="--clusterOnDiagonal" type="boolean" truevalue="--clusterOnDiagonal" falsevalue=""
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
111 label="Perform clustering on the submatrix diagonal"
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
112 help="Clustering is by default carried out on the whole
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
113 submatrices. If this parameter is given, the
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
114 clustering is only carried out based on the submatrix
1
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
115 diagonal (representing values at the same distance to each other)." />
0
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
116
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
117 <param argument="--plotType" type="select" optional="true" label="Plot type">
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
118 <option value="2d">2D</option>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
119 <option value="3d">3D</option>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
120 </param>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
121 <expand macro="colormap" />
1
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
122 <param argument="--vMin" type="float" optional="true" label="vMin"
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
123 help= "Minimum value of the plotted score." />
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
124
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
125 <param argument="--vMax" type="float" optional="true" label="vMax"
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
126 help= "Maximum value of the plotted score." />
0
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
127
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
128 <param name="image_file_format" type="select" label="Image output format">
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
129 <option value="png" selected="True">png</option>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
130 <option value="svg">svg</option>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
131 </param>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
132
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
133 <param name="outputs" type="select" optional="true" multiple="true" label="Optional output files">
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
134 <option value="PrefixMatrix">Save values underlying the final matrix</option>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
135 <option value="ClusterContactPositions">Save the position of the contacts</option>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
136 <option value="HeatmapFile">Heatmap file per chromosome</option>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
137 </param>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
138
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
139 </inputs>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
140 <outputs>
1
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
141 <data name="outFileName" from_work_dir="plot" format="png" label="${tool.name} on ${on_string}: Plot">
0
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
142 <change_format>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
143 <when input="image_file_format" value="svg" format="svg" />
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
144 </change_format>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
145 </data>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
146 <collection name="matrix_values" type="list" label="${tool.name} on ${on_string}: Matrix values">
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
147 <discover_datasets pattern="matrix_values_(?P&lt;designation&gt;.*)\..*" directory="./" format="tabular" />
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
148 </collection>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
149 <collection name="contact_positions" type="list" label="${tool.name} on ${on_string}: Matrix values">
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
150 <discover_datasets pattern="contact_positions_(?P&lt;designation&gt;.*)\..*" directory="./" format="tabular" />
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
151 </collection>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
152 <collection name="heatmap" type="list" label="${tool.name} on ${on_string}: Matrix values">
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
153 <discover_datasets pattern="heatmap_(?P&lt;designation&gt;.*)\..*" directory="./" format="tabular" />
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
154 </collection>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
155 </outputs>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
156 <tests>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
157 <test>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
158 <param name="matrix_h5_cooler" value="Li_et_al_2015.h5" ftype="h5"/>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
159 <param name="BED" value="test_regions.bed" ftype="bed"/>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
160 <param name="numberOfBins" value="30" />
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
161 <param name="range_max" value="900000" />
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
162 <param name="range_min" value="50000" />
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
163 <param name="image_file_format" value="png" />
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
164 <output name="outFileName" value="hicAggregateContacts_results1.png" compare="sim_size" />
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
165 </test>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
166 </tests>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
167 <help><![CDATA[
1
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
168 Aggregation of Hi-C contacts
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
169 ============================
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
170
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
171 **hicAggregateContacts** allows plotting of aggregated Hi-C sub-matrices of a specified list of positions. Positions of interest can for example be binding sites of a specific protein that were determined by ChIP-seq or genetic elements as transcription start sites of active genes.
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
172
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
173 _________________
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
174
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
175 Usage
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
176 -----
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
177
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
178 This tool must be used on Hi-C matrices corrected by ``hicCorrectMatrix``. One should also consider bigger bins than restriction enzyme resolution bins using ``hicMergeMatrixBins``.
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
179
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
180 _________________
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
181
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
182 Optional parameters
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
183 -------------------
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
184
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
185 Optional data output can be selected:
0
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
186
1
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
187 - **Save values underlying the final matrix:** if this option is given, then the values underlying the final matrix will be saved to tab-delimited tables (one per chromosome) using the indicated prefix, for example TSS_to_TSS_chrX.tab. If clustering is performed, then the values are saved including the cluster_id a in TSS_to_TSS_chrX_cluster_1.tab
0
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
188
1
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
189 - **Save the position of the contacts:** if this option is given, then the position of the contacts is saved as (chrom1, start1, end1, chrom2, start2, end2) where chrom_n, start_n, end_n correspond to the pair of positions used to compute the submatrix. The data is saved per chromosome and per cluster separately (one file each).
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
190
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
191 - **Heatmap file per chromosome:** if given, a heatmap file (per chromosome) is saved. Each row in the heatmap contains the diagonal of each of the submatrices centered on the bed file. This file is useful to get an idea of the values that are used for the aggregate matrix and to determine the fraction of submatrices that are aggregated that may have an enrichment at the center.
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
192
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
193 _________________
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
194
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
195 Output
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
196 ------
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
197
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
198 **hicAggregateContacts** outputs a plot of aggregated contacts.
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
199
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
200 Below, you can find an example of an aggregate Hi-C matrix obtained from *Drosophila melanogaster* Hi-C data. The interactions are plotted at binding sites of a protein that were determined by ChIP-seq. We plot sub-matrices of 30 bins (1.5 kb bin size, 45 kb in total). The regions specified in the BED file will be centered between half number of bins and the other half number of bins.The considered range is 300-1000 kb. The range should be adjusted and only contain contacts larger than TAD size to reduce background interactions.
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
201
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
202 .. image:: $PATH_TO_IMAGES/hicAggregateContacts.png
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
203 :width: 80 %
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
204
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
205 This example was calculated using mean interactions of an observed vs. expected transformed Hi-C matrix. Additional options for the matrix transformation are total-counts or z-score. Aggregate contacts can be plotted in 2D or 3D.
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
206
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
207 _________________
0
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
208
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
209 | For more information about HiCExplorer please consider our documentation on readthedocs.io_
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
210
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
211 .. _readthedocs.io: http://hicexplorer.readthedocs.io/en/latest/index.html
1
a49b7fad9421 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2307743fd10f0babde52eec30289fe1682236287
iuc
parents: 0
diff changeset
212 .. _Colormaps: https://matplotlib.org/examples/color/colormaps_reference.html
0
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
213 ]]></help>
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
214 <expand macro="citations" />
44049472de9e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents:
diff changeset
215 </tool>