annotate hicBuildMatrix.xml @ 7:7c5b8da3a052 draft

planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 8def073a083b0619e366436a067a614555190058
author iuc
date Tue, 02 Jan 2018 09:46:28 -0500
parents 747a789ce63c
children 5fd877e2296b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
7c5b8da3a052 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 8def073a083b0619e366436a067a614555190058
iuc
parents: 6
diff changeset
1 <tool id="hicexplorer_hicbuildmatrix" name="@BINARY@" version="@WRAPPER_VERSION@.1">
5
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
2 <description>creates a contact matrix</description>
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
3 <macros>
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
4 <token name="@BINARY@">hicBuildMatrix</token>
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
5 <import>macros.xml</import>
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
6 </macros>
1
8ffb4beeabcf planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents: 0
diff changeset
7 <expand macro="requirements" >
3
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
8 <requirement type="package" version="1.6">samtools</requirement>
1
8ffb4beeabcf planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents: 0
diff changeset
9 </expand>
3
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
11
1
8ffb4beeabcf planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents: 0
diff changeset
12 mkdir ./QCfolder &&
3
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
13 mkdir $qc.files_path &&
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
14 hicBuildMatrix
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
15
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
16 --samFiles
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
17 #for $repeat in $samFiles:
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
18 '${repeat.samFile}'
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
19 #end for
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
20
3
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
21 #if $restrictionCutFileBinSize_conditional.restrictionCutFileBinSize_selector == "optionRestrictionCutFile":
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
22 --restrictionCutFile '$restrictionCutFileBinSize_conditional.restrictionCutFile'
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
23 --minDistance $restrictionCutFileBinSize_conditional.minDistance
6
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
24 --maxLibraryInsertSize $restrictionCutFileBinSize_conditional.maxLibraryInsertSize
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
25 #end if
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
26
3
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
27 #if $restrictionCutFileBinSize_conditional.restrictionCutFileBinSize_selector == "optionBinSize":
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
28 --binSize $restrictionCutFileBinSize_conditional.binSize
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
29 #end if
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
30
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
31
1
8ffb4beeabcf planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents: 0
diff changeset
32 #if $restrictionSequence:
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
33 --restrictionSequence '$restrictionSequence'
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
34 #end if
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
35
1
8ffb4beeabcf planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents: 0
diff changeset
36 #if $region:
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
37 --region '$region'
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
38 #end if
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
39
6
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
40 #if $outputFormat == 'h5'
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
41 --outFileName matrix.h5
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
42 #elif $outputFormat == 'cool'
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
43 --outFileName matrix.cool
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
44 #end if
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
45 --outBam ./unsorted.bam
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
46
3
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
47 $keepSelfCircles
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
48
1
8ffb4beeabcf planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents: 0
diff changeset
49 #if $minMappingQuality and $minMappingQuality is not None:
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
50 --minMappingQuality $minMappingQuality
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
51 #end if
1
8ffb4beeabcf planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents: 0
diff changeset
52
3
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
53 #if $danglingSequence:
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
54 --danglingSequence '$danglingSequence'
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
55 #end if
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
56
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
57 --threads @THREADS@
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
58
1
8ffb4beeabcf planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents: 0
diff changeset
59 --QCfolder ./QCfolder
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
60 &&
1
8ffb4beeabcf planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents: 0
diff changeset
61 mv ./QCfolder/* $qc.files_path/
8ffb4beeabcf planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents: 0
diff changeset
62 &&
8ffb4beeabcf planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents: 0
diff changeset
63 mv $qc.files_path/hicQC.html $qc
7
7c5b8da3a052 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 8def073a083b0619e366436a067a614555190058
iuc
parents: 6
diff changeset
64 && mv $qc.files_path/*.log raw_qc
3
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
65 && samtools sort ./unsorted.bam -o sorted.bam
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
66
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
67 ]]>
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
68 </command>
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
69 <inputs>
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
70 <repeat max="2" min="2" name="samFiles" title="Sam/Bam files to process">
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
71 <param name="samFile" type="data" format="sam,bam"/>
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
72 </repeat>
3
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
73 <conditional name="restrictionCutFileBinSize_conditional">
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
74 <param name="restrictionCutFileBinSize_selector" type="select" label="Choose to use a restriction cut file or a bin size">
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
75 <option value="optionRestrictionCutFile">Restriction cut file</option>
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
76 <option value="optionBinSize" selected="True">Bin size</option>
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
77 </param>
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
78 <when value="optionRestrictionCutFile">
4
1cf8c2444b44 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 3
diff changeset
79 <param argument="--restrictionCutFile" type="data" format="bed" optional="true" label="BED file with all restriction cut places"
3
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
80 help="Should contaion only mappable restriction sites. If given, the bins are set to match the restriction fragments
4
1cf8c2444b44 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 3
diff changeset
81 (i.e. the region between one restriction site and the next)." />
1cf8c2444b44 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 3
diff changeset
82 <param argument="--minDistance" type="integer" value="" optional="true" label="Minimum distance between restriction sites"
3
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
83 help="Restriction sites that are closer that this distance are merged into one.
4
1cf8c2444b44 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 3
diff changeset
84 This option only applies if --restrictionCutFile is given."/>
1cf8c2444b44 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 3
diff changeset
85 <param argument="--maxLibraryInsertSize" type="integer" value="" optional="true"
1cf8c2444b44 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 3
diff changeset
86 label="Maximum library insert size defines different cut offs based on the maximum expected library size"
1cf8c2444b44 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 3
diff changeset
87 help="*This is not the average fragment size* but the higher end of the fragment size distribution (obtained using for example Fragment Analyzer)
1cf8c2444b44 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 3
diff changeset
88 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
1cf8c2444b44 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 3
diff changeset
89 belong to the same fragment (by checking if they are within this max insert size) and to decide if a mate
1cf8c2444b44 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 3
diff changeset
90 is too far away from the nearest restriction site." />
3
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
91 </when>
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
92 <when value="optionBinSize">
4
1cf8c2444b44 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 3
diff changeset
93 <param argument="--binSize" type="integer" value="" optional="true" label="Bin size in bp"
1cf8c2444b44 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 3
diff changeset
94 help="If used, the restriction cut places (if given) are used to only consider reads that are in the vicinity of the resctriction sites.
1cf8c2444b44 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 3
diff changeset
95 Otherwise all reads in the interval are considered. "/>
3
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
96 </when>
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
97 </conditional>
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
98
4
1cf8c2444b44 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 3
diff changeset
99 <param argument="--restrictionSequence" type="text" optional="true" label="Sequence of the restriction site"
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
100 help="This is used to discard reads that end/start with such sequence and that are considered un-ligated fragments or
4
1cf8c2444b44 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 3
diff changeset
101 &quot;dangling-ends&quot;. If not given, such statistics will not be available." />
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
102
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
103 <expand macro="region" />
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
104
3
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
105 <param argument="--keepSelfCircles" type="boolean" truevalue="--keepSelfCircles" falsevalue=""
4
1cf8c2444b44 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 3
diff changeset
106 label="Keep self circles"
1cf8c2444b44 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 3
diff changeset
107 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
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
108
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
109 <expand macro="minMappingQuality" />
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
110
4
1cf8c2444b44 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 3
diff changeset
111 <param argument="--danglingSequence" type="text" optional="true" label="The dangling sequence"
3
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
112 help="Dangling end sequence left by the restriction enzyme. For DpnII for example,
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
113 the dangling end is the same restriction sequence. This is used
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
114 to discard reads that end/start with such sequence
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
115 and that are considered un-ligated fragments or
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
116 'dangling-ends'. If not given, such statistics will
4
1cf8c2444b44 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 1beb50fdb3f5f8fd60e3b9c3d44964d70075616d
iuc
parents: 3
diff changeset
117 not be available."/>
6
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
118 <param name='outputFormat' type='select' label="Output file format">
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
119 <option value='h5'>HiCExplorer format</option>
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
120 <option value="cool">cool</option>
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
121 </param>
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
122 </inputs>
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
123 <outputs>
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
124 <data name="outBam" from_work_dir="sorted.bam" format="bam" label="${tool.name} BAM file on ${on_string}"/>
6
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
125 <data name="outFileName_h5" from_work_dir="matrix.h5" format="h5" label="${tool.name} MATRIX on ${on_string}">
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
126 <filter>outputFormat == 'h5'</filter>
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
127 </data>
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
128 <data name="outFileName_cool" from_work_dir="matrix.cool" format="cool" label="${tool.name} MATRIX on ${on_string}">
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
129 <filter>outputFormat == 'cool'</filter>
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
130 </data>
1
8ffb4beeabcf planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 2f347b0756d720114f037ed1ff9ba4836e1b3b04
bgruening
parents: 0
diff changeset
131 <data name="qc" format="html" label="${tool.name} QC"/>
7
7c5b8da3a052 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 8def073a083b0619e366436a067a614555190058
iuc
parents: 6
diff changeset
132 <data name="raw_qc" from_work_dir='raw_qc' label="${tool.name} raw QC" />
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
133 </outputs>
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
134 <tests>
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
135 <test>
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
136 <repeat name="samFiles">
6
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
137 <param name="samFile" value="small_test_R1_unsorted.sam"/>
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
138 </repeat>
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
139 <repeat name="samFiles">
6
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
140 <param name="samFile" value="small_test_R2_unsorted.sam"/>
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
141 </repeat>
3
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
142 <conditional name="restrictionCutFileBinSize_conditional">
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
143 <param name="restrictionCutFileBinSize_selector" value="optionBinSize"/>
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
144 <param name="binSize" value="5000"/>
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
145 </conditional>
6
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
146 <param name='outputFormat' value='h5'/>
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
147
3
41d4044e1dfe planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 4d61b6bf2fed275ab38c226d0c4390b095a38251
iuc
parents: 1
diff changeset
148 <output name="outBam" file="small_test_matrix_result_sorted.bam" ftype="bam"/>
6
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
149 <output name="outFileName_h5" file="small_test_matrix_2.h5" ftype="h5" compare="sim_size"/>
7
7c5b8da3a052 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 8def073a083b0619e366436a067a614555190058
iuc
parents: 6
diff changeset
150 <output name="raw_qc" file='raw_qc_report' compare='diff' lines_diff='2'/>
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
151 </test>
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
152 </tests>
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
153 <help><![CDATA[
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
154
5
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
155 Creation of the contact matrix
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
156 ===============================
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
157
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
158 ``hicBuildMatrix`` creates a contact matrix based on Hi-C read pairs. It requires two sam or bam files
6
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
159 corresponding to the first and second mates of the paired-end H-C reads. The sam and bam files should
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
160 not be sorted by position. There are two main options to create the Hi-C contact matrix, either by
5
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
161 fixed bin size (eg. 10.000 bp) or by bins of variable restriction fragment size length.
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
162 ``hicBuildMatrix`` generates a quality control output that can be used to analyze the quality of the Hi-C reads.
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
163
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
164 Input
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
165 -----
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
166
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
167 `hicBuildMatrix` is having the following parameters:
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
168
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
169 Parameters
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
170 __________
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
171
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
172
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
173 - two input BAM/SAM files
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
174 - a bin size
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
175 - a restriction cut file as an alternative to the bin size
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
176 - restriction sequence: e.g. HindIII: GATC
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
177
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
178
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
179
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
180 Output
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
181 ------
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
182
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
183 `hicBuildMatrix` creates as an output:
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
184 - the contact matrix
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
185 - a bam file with the accepted alignments
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
186 - a quality report.
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
187
5
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
188 Example plot
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
189 -----------------------------------------------------------------
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
190 .. image:: $PATH_TO_IMAGES/SRR027956.svg
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
191 :width: 70%
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
192
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
193 Contact matrix created with `hicPlotMatrix`.
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
194
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
195 Quality report
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
196 --------------
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
197
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
198 The quality report gives you information about:
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
199
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
200 - how many pairs were used to build the contact matrix
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
201 - dangling end pairs: These are reads that start with the restriction site and constitute reads that were digested but no ligated.
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
202 - same fragment pairs: These are read mates, facing inward, separated by up to 800 bp that do not have a restriction enzyme in between. These read pairs are not valid Hi-C pairs.
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
203 - self circles: Self circles are defined as pairs within 25kb with 'outward' read orientation
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
204 - self ligations: These are read pairs with a restriction site in between that are within 800 bp.
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
205
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
206 Contact distance:
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
207 _________________
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
208 - inter chromosomal
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
209 - short range < 20 kb
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
210 - long range
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
211
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
212 Read orientation:
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
213 _________________
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
214 - inward pairs
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
215 - outward pairs
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
216 - left pairs
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
217 - right pairs
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
218
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
219 .. image:: $PATH_TO_IMAGES/hicQC.png
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
220 :width: 70 %
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
221
6
747a789ce63c planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 80462804e4fd7deafbcf8e8c5283cc7a98fa7dd5
iuc
parents: 5
diff changeset
222
5
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
223 | For more information about HiCExplorer please consider our documentation on readthedocs.io_.
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
224
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
225 .. _readthedocs.io: http://hicexplorer.readthedocs.io/en/latest/index.html
654282127b45 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit dfa5a68cb20842407941c7ffda9ef956a0e86a04
iuc
parents: 4
diff changeset
226
0
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
227
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
228 ]]></help>
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
229 <expand macro="citations" />
611b0f02e109 planemo upload for repository https://github.com/maxplanck-ie/HiCExplorer/tree/master/galaxy/wrapper/ commit 6a4d8b48a6504eacbb9ed7228f77117fa759286d-dirty
bgruening
parents:
diff changeset
230 </tool>