annotate hicValidateLocations.xml @ 6:662109a754b5 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
author iuc
date Tue, 16 Mar 2021 14:54:56 +0000
parents bccefbea9b8d
children 1d201e8378b3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
662109a754b5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
1 <tool id="hicexplorer_hicvalidatelocations" name="@BINARY@" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@">
0
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
2 <description>validate detected loops with protein peaks.</description>
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
3 <macros>
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
4 <token name="@BINARY@">hicValidateLocations</token>
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
5 <import>macros.xml</import>
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
6 </macros>
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
7 <expand macro="requirements" />
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
9 @BINARY@
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
10 --data '$data'
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
11 --protein '$protein'
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
12 --method loops
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
13 --resolution '$resolution'
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
14 $addChrPrefixLoops
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
15 $addChrPrefixProtein
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
16 --outFileName outfile
6
662109a754b5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
17 ]]> </command>
0
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
18 <inputs>
6
662109a754b5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
19 <param argument="--data" type="data" format='bed' label="Loop file" help="The loop file from hicDetectLoops. To use files from other sources, please follow 'chr start end chr start end' format." />
662109a754b5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
20 <param argument="--protein" type="data" format='bed' label="Protein file" help="The protein peak file." />
662109a754b5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
21 <param argument="--resolution" type="integer" value="" label="Used resolution" help='The to be binned resolution.' />
662109a754b5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
22 <param argument='--addChrPrefixLoops' type='boolean' truevalue='--addChrPrefixLoops' falsevalue="" checked="false" label="Add chr prefix to loops." help="Adding a 'chr'-prefix to chromosome name of the loops." />
662109a754b5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
23 <param argument='--addChrPrefixProtein' type='boolean' truevalue='--addChrPrefixProtein' falsevalue="" checked="false" label="Add chr prefix to protein." help="Adding a 'chr'-prefix to chromosome name of the protein." />
0
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
24 </inputs>
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
25 <outputs>
6
662109a754b5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
26 <data name="statistic" from_work_dir="outfile_statistics" format="bed" label="${tool.name} on [${on_string}]: Statistic" />
662109a754b5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
27 <data name="mergedLoops" from_work_dir="outfile_matched_locations" format="bed" label="${tool.name} on [${on_string}]: Matched locations" />
0
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
28 </outputs>
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
29 <tests>
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
30 <test>
6
662109a754b5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
31 <param name="data" ftype='bed' value="hicValidateLocations/loops_1.bedgraph" />
662109a754b5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
32 <param name="protein" ftype='bed' value="hicValidateLocations/GSM935376_hg19_Gm12878_Smc3.narrowPeak" />
662109a754b5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
33 <param name="resolution" value="10000" />
662109a754b5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
34 <param name="addChrPrefixLoops" value="True" />
662109a754b5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
35 <output name="statistic" file="hicValidateLocations/overlap_smc3_statistics" ftype="bed" lines_diff="2" />
662109a754b5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
36 <output name="mergedLoops" file="hicValidateLocations/overlap_smc3_matched_locations" ftype="bed" lines_diff="4" />
0
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
37 </test>
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
38 </tests>
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
39 <help><![CDATA[
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
40
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
41 Validate locations
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
42 ==================
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
43
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
44 This script overlaps the loop locations with protein locations to determine the accuracy of the loop detection.
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
45 Loops need to have format as follows:
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
46
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
47 `chr start end chr start end`
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
48
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
49 The protein peaks need to be in narrowPeaks or broadPeak format.
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
50
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
51 A protein match is successfull if at the bin of the x and y location a protein peak is overlapped.
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
52 A bin is assumed to have a protein if one or more protein peaks falling within the bin region.
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
53 The value of the protein is not considered, only match or non-match.
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
54
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
55 For more information about HiCExplorer please consider our documentation on readthedocs.io_
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
56
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
57 .. _readthedocs.io: http://hicexplorer.readthedocs.io/en/latest/index.html
6
662109a754b5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
58 ]]> </help>
0
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
59 <expand macro="citations" />
f011486cbaaa "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
60 </tool>