Mercurial > repos > bgruening > hicexplorer_chicviewpoint
annotate chicViewpoint.xml @ 8:f881c94fb3b3 draft
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
author | iuc |
---|---|
date | Wed, 18 Oct 2023 10:44:35 +0000 |
parents | dbfd2cfc0f66 |
children |
rev | line source |
---|---|
6
dbfd2cfc0f66
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents:
4
diff
changeset
|
1 <tool id="hicexplorer_chicviewpoint" name="@BINARY@" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@"> |
0
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
2 <description>computes viewpoints with the given reference points and a background model.</description> |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
3 <macros> |
6d76e532b669
"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@">chicViewpoint</token> |
6d76e532b669
"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> |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
6 </macros> |
6d76e532b669
"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" /> |
6d76e532b669
"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[ |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
9 #import re |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
10 |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
11 #for $m in $matrix_h5_cooler_multiple: |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
12 #set identifier = @ESCAPE_IDENTIFIER_M@ |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
13 ln -s '$m' '$identifier' && |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
14 #end for |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
15 #set $m = ' '.join([ '\'%s\'' % @ESCAPE_IDENTIFIER_MATRIX@ for $matrix in $matrix_h5_cooler_multiple ]) |
2
0dabfd9a496b
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 4b602d427e0fc0da5353a4510798349de98e4ae4"
iuc
parents:
1
diff
changeset
|
16 |
0
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
17 @BINARY@ |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
18 --matrices $m |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
19 --range $rangeUpstream $rangeDownstream |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
20 --referencePoints '$referencePoints' |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
21 --averageContactBin $averageContactBin |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
22 --fixateRange $fixateRange |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
23 --threads @THREADS@ |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
24 --backgroundModelFile '$backgroundModelFile' |
8
f881c94fb3b3
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
6
diff
changeset
|
25 --outFileName interactionFiles.hdf5 |
0
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
26 |
6
dbfd2cfc0f66
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents:
4
diff
changeset
|
27 ]]> </command> |
0
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
28 <inputs> |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
29 <expand macro="matrix_h5_cooler_multiple_macro" /> |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
30 |
8
f881c94fb3b3
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
6
diff
changeset
|
31 <param argument="--referencePoints" type="data" format="interval" label="Reference points" help="Bed file contains all reference points which should be used to create viewpoints." /> |
f881c94fb3b3
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
6
diff
changeset
|
32 <param name="rangeUpstream" type="integer" value="500000" label="Upstream range" help="Defines the region upstream of a reference point which should be considered in the analysis." /> |
f881c94fb3b3
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
6
diff
changeset
|
33 <param name="rangeDownstream" type="integer" value="500000" label="Downstream range" help="Defines the region upstream of a reference point which should be considered in the analysis." /> |
0
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
34 |
8
f881c94fb3b3
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
6
diff
changeset
|
35 <param argument="--backgroundModelFile" type="data" format="tabular" label="Background model" help="The background file computed by chicViewpointBackgroundModel" /> |
f881c94fb3b3
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
6
diff
changeset
|
36 <param argument="--averageContactBin" type="integer" value="5" label="Average contacts window size" help="Average the contacts of n bins via a sliding window approach." /> |
f881c94fb3b3
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
6
diff
changeset
|
37 <param argument="--fixateRange" type="integer" value="500000" label="Clip background distance" help="Fixate score of background model starting at distance x. E.g. all values greater 500kb are set to the value of the 500kb bin." /> |
0
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
38 </inputs> |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
39 <outputs> |
8
f881c94fb3b3
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
6
diff
changeset
|
40 <data name="interactionFileNames" from_work_dir="interactionFiles.hdf5" format="h5" label="${tool.name} interaction file" /> |
0
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
41 </outputs> |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
42 <tests> |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
43 <test> |
6
dbfd2cfc0f66
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents:
4
diff
changeset
|
44 <param name="matrix_h5_cooler_multiple" value="cHi-C/FL-E13-5_chr1.cool,cHi-C/MB-E10-5_chr1.cool" /> |
dbfd2cfc0f66
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents:
4
diff
changeset
|
45 <param name="referencePoints" value="cHi-C/referencePoints_chicViewpoint.bed" /> |
dbfd2cfc0f66
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents:
4
diff
changeset
|
46 <param name="backgroundModelFile" value="cHi-C/background.txt" /> |
dbfd2cfc0f66
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents:
4
diff
changeset
|
47 <param name="fixateRange" value="500000" /> |
dbfd2cfc0f66
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents:
4
diff
changeset
|
48 <param name="rangeUpstream" value="200000" /> |
dbfd2cfc0f66
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents:
4
diff
changeset
|
49 <param name="rangeDownstream" value="200000" /> |
8
f881c94fb3b3
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
6
diff
changeset
|
50 <output name="interactionFileNames" ftype="h5"> |
f881c94fb3b3
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
6
diff
changeset
|
51 <assert_contents> |
f881c94fb3b3
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
6
diff
changeset
|
52 <has_h5_attribute key="averageContactBin" value="5" /> |
f881c94fb3b3
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
6
diff
changeset
|
53 <has_h5_attribute key="fixateRange" value="500000" /> |
f881c94fb3b3
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
6
diff
changeset
|
54 <!-- <has_h5_attribute key="range" value="200000,200000" /> --> |
f881c94fb3b3
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
6
diff
changeset
|
55 <has_h5_attribute key="resolution" value="1000" /> |
f881c94fb3b3
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
6
diff
changeset
|
56 <has_h5_attribute key="type" value="interactions" /> |
f881c94fb3b3
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
6
diff
changeset
|
57 </assert_contents> |
f881c94fb3b3
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
6
diff
changeset
|
58 </output> |
4
78b70d78a596
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit db84cc85222518217286b42262935edd3a49c98e"
iuc
parents:
3
diff
changeset
|
59 </test> |
0
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
60 </tests> |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
61 <help><![CDATA[ |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
62 |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
63 Compute viewpoints for all given reference points |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
64 ================================================= |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
65 |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
66 Computes per input matrix all viewpoints which are defined in the reference points file. All files are stored in the folder defined by `--outputFolder`, the files |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
67 are named by the name of the reference point, the sample name and the location of the reference point: |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
68 |
2
0dabfd9a496b
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 4b602d427e0fc0da5353a4510798349de98e4ae4"
iuc
parents:
1
diff
changeset
|
69 gene_matrix_name_chr_start_end.txt |
0
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
70 |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
71 If multiple reference points are used and the processing downstream should be automated via batch processing mode, please activate `--writeFileNamesToFile`. In this |
2
0dabfd9a496b
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 4b602d427e0fc0da5353a4510798349de98e4ae4"
iuc
parents:
1
diff
changeset
|
72 file, all the file names will be written to; in the case of multiple samples two consecutive lines are considered as treatment vs control in the differential analysis. |
0
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
73 |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
74 For more information about HiCExplorer please consider our documentation on readthedocs.io_ |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
75 |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
76 .. _readthedocs.io: http://hicexplorer.readthedocs.io/en/latest/index.html |
6
dbfd2cfc0f66
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents:
4
diff
changeset
|
77 ]]> </help> |
0
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
78 <expand macro="citations" /> |
6d76e532b669
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff
changeset
|
79 </tool> |