annotate hicBuildMatrix.xml @ 11:4ceaee0043a5 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:35:48 -0400
parents 495ae38f6e0d
children 8bf84c4cb1cb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
707f691c974c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 0456f085bac2c88b8cbddfcf12b02776d2a0d457
bgruening
parents: 7
diff changeset
1 <tool id="hicexplorer_hicbuildmatrix" name="@BINARY@" version="@WRAPPER_VERSION@.0">
9
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
2 <description>create a contact matrix</description>
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
3 <macros>
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
4 <token name="@BINARY@">hicBuildMatrix</token>
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
5 <import>macros.xml</import>
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
6 </macros>
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
7 <expand macro="requirements" >
2
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
8 <requirement type="package" version="1.6">samtools</requirement>
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
9 </expand>
2
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
11
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
12 mkdir ./QCfolder &&
2
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
13 mkdir $qc.files_path &&
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
14 hicBuildMatrix
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
15
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
16 --samFiles
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
17 #for $repeat in $samFiles:
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
18 '${repeat.samFile}'
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
19 #end for
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
20
2
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
21 #if $restrictionCutFileBinSize_conditional.restrictionCutFileBinSize_selector == "optionRestrictionCutFile":
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
22 --restrictionCutFile '$restrictionCutFileBinSize_conditional.restrictionCutFile'
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
23 --minDistance $restrictionCutFileBinSize_conditional.minDistance
5
3bc1425f9000 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
24 --maxLibraryInsertSize $restrictionCutFileBinSize_conditional.maxLibraryInsertSize
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
25 #end if
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
26
2
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
27 #if $restrictionCutFileBinSize_conditional.restrictionCutFileBinSize_selector == "optionBinSize":
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
28 --binSize $restrictionCutFileBinSize_conditional.binSize
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
29 #end if
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
30
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
31
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
32 #if $restrictionSequence:
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
33 --restrictionSequence '$restrictionSequence'
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
34 #end if
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
35
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
36 #if $region:
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
37 --region '$region'
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
38 #end if
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
39
7
be42758f532e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit d76f2040a05a5f8752cbfe9a8bc1ef9efae45c01
iuc
parents: 6
diff changeset
40 --outFileName matrix.$outputFormat
9
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
41
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
42 #if $outBam_Boolean:
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
43 $outBam_Boolean ./unsorted.bam
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
44 #end if
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
45
2
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
46 $keepSelfCircles
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
47
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
48 #if $minMappingQuality and $minMappingQuality is not None:
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
49 --minMappingQuality $minMappingQuality
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
50 #end if
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
51
2
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
52 #if $danglingSequence:
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
53 --danglingSequence '$danglingSequence'
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
54 #end if
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
55
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
56 --threads @THREADS@
9
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
57
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
58 --QCfolder ./QCfolder
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
59 &&
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
60 mv ./QCfolder/* $qc.files_path/
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
61 &&
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
62 mv $qc.files_path/hicQC.html $qc
6
30d427846764 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 8def073a083b0619e366436a067a614555190058
iuc
parents: 5
diff changeset
63 && mv $qc.files_path/*.log raw_qc
7
be42758f532e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit d76f2040a05a5f8752cbfe9a8bc1ef9efae45c01
iuc
parents: 6
diff changeset
64 && mv matrix.$outputFormat matrix
9
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
65 #if $outBam_Boolean:
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
66 && samtools sort ./unsorted.bam -o sorted.bam
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
67 #end if
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
68
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
69 ]]>
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
70 </command>
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
71 <inputs>
9
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
72 <repeat max="2" min="2" name="samFiles" title="Sam/Bam files to process (forward/reverse)"
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
73 help="Please use the special BAM datatype: qname_input_sorted.bam and use for 'bowtie2' the '--reorder' option to create a BAM file.">
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
74 <param name="samFile" type="data" format="sam,qname_input_sorted.bam"/>
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
75 </repeat>
2
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
76 <conditional name="restrictionCutFileBinSize_conditional">
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
77 <param name="restrictionCutFileBinSize_selector" type="select" label="Choose to use a restriction cut file or a bin size">
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
78 <option value="optionRestrictionCutFile">Restriction cut file</option>
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
79 <option value="optionBinSize" selected="True">Bin size</option>
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
80 </param>
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
81 <when value="optionRestrictionCutFile">
3
2a13bfe5bff2 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 2
diff changeset
82 <param argument="--restrictionCutFile" type="data" format="bed" optional="true" label="BED file with all restriction cut places"
2
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
83 help="Should contaion only mappable restriction sites. If given, the bins are set to match the restriction fragments
3
2a13bfe5bff2 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 2
diff changeset
84 (i.e. the region between one restriction site and the next)." />
2a13bfe5bff2 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 2
diff changeset
85 <param argument="--minDistance" type="integer" value="" optional="true" label="Minimum distance between restriction sites"
2
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
86 help="Restriction sites that are closer that this distance are merged into one.
3
2a13bfe5bff2 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 2
diff changeset
87 This option only applies if --restrictionCutFile is given."/>
2a13bfe5bff2 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 2
diff changeset
88 <param argument="--maxLibraryInsertSize" type="integer" value="" optional="true"
2a13bfe5bff2 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 2
diff changeset
89 label="Maximum library insert size defines different cut offs based on the maximum expected library size"
2a13bfe5bff2 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 2
diff changeset
90 help="*This is not the average fragment size* but the higher end of the fragment size distribution (obtained using for example Fragment Analyzer)
2a13bfe5bff2 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 2
diff changeset
91 which usually is between 800 to 1500 bp. If this value if not known use the default of 1000. The insert value is used to decide if two mates
2a13bfe5bff2 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 2
diff changeset
92 belong to the same fragment (by checking if they are within this max insert size) and to decide if a mate
2a13bfe5bff2 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 2
diff changeset
93 is too far away from the nearest restriction site." />
2
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
94 </when>
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
95 <when value="optionBinSize">
3
2a13bfe5bff2 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 2
diff changeset
96 <param argument="--binSize" type="integer" value="" optional="true" label="Bin size in bp"
2a13bfe5bff2 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 2
diff changeset
97 help="If used, the restriction cut places (if given) are used to only consider reads that are in the vicinity of the resctriction sites.
2a13bfe5bff2 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 2
diff changeset
98 Otherwise all reads in the interval are considered. "/>
2
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
99 </when>
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
100 </conditional>
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
101
3
2a13bfe5bff2 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 2
diff changeset
102 <param argument="--restrictionSequence" type="text" optional="true" label="Sequence of the restriction site"
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
103 help="This is used to discard reads that end/start with such sequence and that are considered un-ligated fragments or
3
2a13bfe5bff2 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 2
diff changeset
104 &quot;dangling-ends&quot;. If not given, such statistics will not be available." />
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
105
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
106 <expand macro="region" />
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
107
2
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
108 <param argument="--keepSelfCircles" type="boolean" truevalue="--keepSelfCircles" falsevalue=""
3
2a13bfe5bff2 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 2
diff changeset
109 label="Keep self circles"
2a13bfe5bff2 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 2
diff changeset
110 help="If set, outward facing reads without any restriction fragment (self circles) are kept. They will be counted and shown in the QC plots." />
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
111
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
112 <expand macro="minMappingQuality" />
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
113
9
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
114 <param argument="--danglingSequence" type="text" optional="true" label="Dangling sequence"
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
115 help="Sequence left by the restriction enzyme after cutting.
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
116 Each restriction enzyme recognizes a different DNA sequence and,
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
117 after cutting, they leave behind a specific ‘sticky’ end or dangling end sequence.
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
118 For example, for HindIII the restriction site is AAGCTT and the dangling end is AGCT.
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
119 For DpnII, the restriction site and dangling end sequence are the same: GATC.
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
120 This information is easily found on the description of the restriction enzyme.
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
121 The dangling sequence is used to classify and report reads whose 5’ end starts with such sequence as dangling-end reads.
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
122 A significant portion of dangling-end reads in a sample are indicative of a problem with the re-ligation step of the protocol. "/>
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
123
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
124 <param name='outBam_Boolean' type='boolean' truevalue='--outBam' falsevalue="" checked="false" label="Save valid Hi-C reads in BAM file"
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
125 help="A bam
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
126 file containing all valid Hi-C reads can be created
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
127 using this option. This bam file could be useful to
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
128 inspect the distribution of valid Hi-C reads pairs or
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
129 for other downstream analyses, but is not used by any
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
130 HiCExplorer tool. Computation will be significantly
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
131 longer if this option is set."/>
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
132
5
3bc1425f9000 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
133 <param name='outputFormat' type='select' label="Output file format">
3bc1425f9000 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
134 <option value='h5'>HiCExplorer format</option>
3bc1425f9000 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
135 <option value="cool">cool</option>
3bc1425f9000 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
136 </param>
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
137 </inputs>
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
138 <outputs>
9
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
139 <data name="outBam" from_work_dir="sorted.bam" format="bam" label="${tool.name} BAM file on ${on_string}">
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
140 <filter>outBam_Boolean</filter>
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
141 </data>
7
be42758f532e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit d76f2040a05a5f8752cbfe9a8bc1ef9efae45c01
iuc
parents: 6
diff changeset
142 <data name="outFileName" from_work_dir="matrix" format="h5" label="${tool.name} MATRIX on ${on_string}">
be42758f532e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit d76f2040a05a5f8752cbfe9a8bc1ef9efae45c01
iuc
parents: 6
diff changeset
143 <change_format>
be42758f532e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit d76f2040a05a5f8752cbfe9a8bc1ef9efae45c01
iuc
parents: 6
diff changeset
144 <when input="outputFormat" value="cool" format="cool" />
be42758f532e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit d76f2040a05a5f8752cbfe9a8bc1ef9efae45c01
iuc
parents: 6
diff changeset
145 </change_format>
5
3bc1425f9000 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
146 </data>
9
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
147 <data name="qc" format="html" label="${tool.name} QC on ${on_string}"/>
7
be42758f532e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit d76f2040a05a5f8752cbfe9a8bc1ef9efae45c01
iuc
parents: 6
diff changeset
148
9
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
149 <data name="raw_qc" from_work_dir='raw_qc' format='txt' label="${tool.name} raw QC on ${on_string}" />
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
150 </outputs>
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
151 <tests>
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
152 <test>
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
153 <repeat name="samFiles">
5
3bc1425f9000 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
154 <param name="samFile" value="small_test_R1_unsorted.sam"/>
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
155 </repeat>
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
156 <repeat name="samFiles">
5
3bc1425f9000 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
157 <param name="samFile" value="small_test_R2_unsorted.sam"/>
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
158 </repeat>
2
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
159 <conditional name="restrictionCutFileBinSize_conditional">
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
160 <param name="restrictionCutFileBinSize_selector" value="optionBinSize"/>
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
161 <param name="binSize" value="5000"/>
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
162 </conditional>
5
3bc1425f9000 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
163 <param name='outputFormat' value='h5'/>
9
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
164 <param name='outBam_Boolean' value="True" />
2
eb0d14cdf8b8 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
bgruening
parents: 0
diff changeset
165 <output name="outBam" file="small_test_matrix_result_sorted.bam" ftype="bam"/>
7
be42758f532e planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit d76f2040a05a5f8752cbfe9a8bc1ef9efae45c01
iuc
parents: 6
diff changeset
166 <output name="outFileName" file="small_test_matrix_2.h5" ftype="h5" compare="sim_size"/>
6
30d427846764 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 8def073a083b0619e366436a067a614555190058
iuc
parents: 5
diff changeset
167 <output name="raw_qc" file='raw_qc_report' compare='diff' lines_diff='2'/>
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
168 </test>
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
169 </tests>
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
170 <help><![CDATA[
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
171
4
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
172 Creation of the contact matrix
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
173 ===============================
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
174
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
175
9
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
176 **hicBuildMatrix** creates a contact matrix based on Hi-C read pairs. It requires two sam or bam files
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
177 corresponding to the first and second mates of the paired-end Hi-C reads mapped on the reference genome.
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
178 The sam and bam files should not be sorted by position. There are two main options to create the Hi-C contact matrix,
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
179 either by fixed bin size (eg. 10000 bp) or by bins of variable length following restriction enzyme sites location in the genome (restriction enzyme resolution).
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
180 **hicBuildMatrix** generates a quality control output that can be used to analyze the quality of the Hi-C reads to assess if the experiment and sequencing were successful.
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
181
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
182 _________________
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
183
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
184
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
185 Usage
4
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
186 -----
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
187
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
188
9
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
189 This tool must be used on paired sam / bam files produced with a program that supports local alignment (e.g. Bowtie2) where both PE reads are mapped using the --local option.
4
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
190
9
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
191 _________________
4
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
192
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
193
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
194 Output
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
195 ------
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
196
9
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
197 **hicBuildMatrix** creates multiple outputs:
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
198
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
199 - The contact matrix used by HiCExplorer for all downstream analyses.
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
200 - A bam file with the accepted alignments, which can be useful to inspect the distribution of valid Hi-C reads pairs, notably around restriction enzyme sites or for other downstream analyses. This file is not used by any HiCExplorer tools.
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
201 - A quality control report to assess if the Hi-C protocol and library contrusction were successful.
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
202
4
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
203 Example plot
9
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
204 ++++++++++++
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
205
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
206 .. image:: hicPlotMatrix.png
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
207 :width: 50%
4
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
208
9
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
209 Contact matrix of *Drosophila melanogaster* embryos built with **hicBuildMatrix** and visualized using ``hicPlotMatrix``. Hi-C matrix bins were merged to a 25 kb bin size before plotting using ``hicMergeMatrixBins``.
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
210
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
211
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
212
4
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
213
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
214 Quality report
9
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
215 ++++++++++++++
4
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
216
9
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
217 A quality report is produced alongside the contact matrix.
4
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
218
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
219 .. image:: $PATH_TO_IMAGES/hicQC.png
9
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
220 :width: 40%
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
221
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
222 Several plots, that are described in details below, are comprised inside this report.
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
223
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
224 .. image:: $PATH_TO_IMAGES/hicQC_pairs_sequenced.png
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
225 :width: 40%
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
226
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
227 On the plot above, we can see how many reads were sequenced per sample (pairs considered), how many reads were mappable, unique and of high quality and how many reads passed all quality controls and are thus useful for further analysis (pairs used). All quality controls used for read filtering are explained below.
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
228
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
229 .. image:: $PATH_TO_IMAGES/hicQC_unmappable_and_non_unique.png
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
230 :width: 40%
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
231
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
232 The figure above contains the fraction of reads with respect to the total number of reads that did not map, that have a low quality score or that didn't map uniquely to the genome. In our example we can see that Sample 3 has the highest fraction of pairs used. We explain the differences between the three samples on the plot below.
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
233
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
234 .. image:: $PATH_TO_IMAGES/hicQC_pairs_discarded.png
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
235 :width: 40%
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
236
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
237 This figure contains the fraction of read pairs (with respect to mappable and unique reads) that were discarded when building the Hi-C matrix. You can find the description of each category below:
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
238
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
239 - **Dangling ends:** reads that start with the restriction site and constitute reads that were digested but not ligated. Sample 1 in our example has a high fraction of dangling ends (and thus a low proportion of pairs used). Reasons for this can be inefficient ligation or insufficient removal of danging ends during samples preparation.
4
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
240
9
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
241 - **Duplicated pairs:** reads that have the same sequence due to PCR amplification. For example, Sample 2 was amplified too much and thus has a very high fraction of duplicated pairs.
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
242
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
243 - **Same fragment:** read mates facing inward, separated by up to 800bp that do not have a restriction enzyme site in between. These read pairs are not valid Hi-C pairs and are thus discarded from further analyses.
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
244
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
245 - **Self circle:** read pairs within 25kb with 'outward' read orientation.
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
246
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
247 - **Self ligation:** read pairs with a restriction site in between that are within 800bp.
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
248
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
249 .. image:: $PATH_TO_IMAGES/hicQC_distance.png
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
250 :width: 40%
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
251
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
252 The figure above contains the fraction of read pairs (with respect to mappable reads) that compose inter chromosomal, short range (< 20kb) or long range contacts. Inter chromosomal reads of a wild-type sample are expected to be low. Trans-chromosomal contacts can be primarily considered as random ligation events. These would be expected to contribute to technical noise that may obscure some of the finer features in the Hi-C datasets (Nagano *et al.* 2015, Comparison of Hi-C results using in-solution versus in-nucleus ligation, doi: https://doi.org/10.1186/s13059-015-0753-7). As such, a high fraction of inter chromosomal reads is an indicator of low sample quality, but it can also be associated to cell cycle changes (Nagano *et al.* 2018, Cell-cycle dynamics of chromosomal organisation at single-cell resolution, doi: https://doi.org/10.1038/nature23001).
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
253
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
254 Short range and long range contacts proportions can be associated to how the fixation is performed during Hi-C sample preparation. These two proportions also directly impact the Hi-C corrected counts versus genomic distance plots generated by hicPlotDistVsCounts.
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
255
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
256 .. image:: $PATH_TO_IMAGES/hicQC_read_orientation.png
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
257 :width: 40%
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
258
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
259 The last figure shows the fractions of inward, outward, left or right read pairs (with respect to mappable reads). Deviations from an equal distribution indicates problems during sample preparation.
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
260
495ae38f6e0d planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit eec0a4d5a7c5ba4ec0fbd2ead8280c3d143bb9d8
iuc
parents: 8
diff changeset
261 _________________
5
3bc1425f9000 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
bgruening
parents: 4
diff changeset
262
4
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
263 | For more information about HiCExplorer please consider our documentation on readthedocs.io_.
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
264
652fdcbff650 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 3
diff changeset
265 .. _readthedocs.io: http://hicexplorer.readthedocs.io/en/latest/index.html
0
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
266 ]]></help>
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
267 <expand macro="citations" />
9767c021cd58 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents:
diff changeset
268 </tool>