Mercurial > repos > bgruening > hicexplorer_chicviewpoint

annotate chicViewpoint.xml @ 9:844ec92a79cd draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 69bb60ab875c1c1769298678f0890d8b92f1899d
author iuc
date Thu, 05 Dec 2024 17:38:49 +0000
parents ec40077337e3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
844ec92a79cd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 69bb60ab875c1c1769298678f0890d8b92f1899d
iuc
parents: 7
diff changeset
1 <tool id="hicexplorer_chicviewpoint" name="@BINARY@" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
0
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
2 <description>computes viewpoints with the given reference points and a background model.</description>
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
3 <macros>
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
4 <token name="@BINARY@">chicViewpoint</token>
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
5 <import>macros.xml</import>
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
6 </macros>
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
7 <expand macro="requirements" />
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
9 #import re
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
10
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
11 #for $m in $matrix_h5_cooler_multiple:
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
12 #set identifier = @ESCAPE_IDENTIFIER_M@
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
13 ln -s '$m' '$identifier' &&
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
14 #end for
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
15 #set $m = ' '.join([ '\'%s\'' % @ESCAPE_IDENTIFIER_MATRIX@ for $matrix in $matrix_h5_cooler_multiple ])
1
7a659307d3ff "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 4b602d427e0fc0da5353a4510798349de98e4ae4"
iuc
parents: 0
diff changeset
16
0
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
17 @BINARY@
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
18 --matrices $m
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
19 --range $rangeUpstream $rangeDownstream
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
20 --referencePoints '$referencePoints'
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
21 --averageContactBin $averageContactBin
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
22 --fixateRange $fixateRange
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
23 --threads @THREADS@
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
24 --backgroundModelFile '$backgroundModelFile'
7
ec40077337e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 8586409c5f329eaf75902eedc3d29a6e82560788
iuc
parents: 5
diff changeset
25 --outFileName interactionFiles.hdf5
0
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
26
5
7403e41df69e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
27 ]]> </command>
0
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
28 <inputs>
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
29 <expand macro="matrix_h5_cooler_multiple_macro" />
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
30
7
ec40077337e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 8586409c5f329eaf75902eedc3d29a6e82560788
iuc
parents: 5
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." />
ec40077337e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 8586409c5f329eaf75902eedc3d29a6e82560788
iuc
parents: 5
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." />
ec40077337e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 8586409c5f329eaf75902eedc3d29a6e82560788
iuc
parents: 5
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
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
34
7
ec40077337e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 8586409c5f329eaf75902eedc3d29a6e82560788
iuc
parents: 5
diff changeset
35 <param argument="--backgroundModelFile" type="data" format="tabular" label="Background model" help="The background file computed by chicViewpointBackgroundModel" />
ec40077337e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 8586409c5f329eaf75902eedc3d29a6e82560788
iuc
parents: 5
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." />
ec40077337e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 8586409c5f329eaf75902eedc3d29a6e82560788
iuc
parents: 5
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
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
38 </inputs>
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
39 <outputs>
7
ec40077337e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 8586409c5f329eaf75902eedc3d29a6e82560788
iuc
parents: 5
diff changeset
40 <data name="interactionFileNames" from_work_dir="interactionFiles.hdf5" format="h5" label="${tool.name} interaction file" />
0
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
41 </outputs>
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
42 <tests>
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
43 <test>
5
7403e41df69e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
44 <param name="matrix_h5_cooler_multiple" value="cHi-C/FL-E13-5_chr1.cool,cHi-C/MB-E10-5_chr1.cool" />
7403e41df69e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
45 <param name="referencePoints" value="cHi-C/referencePoints_chicViewpoint.bed" />
7403e41df69e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
46 <param name="backgroundModelFile" value="cHi-C/background.txt" />
7403e41df69e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
47 <param name="fixateRange" value="500000" />
7403e41df69e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
48 <param name="rangeUpstream" value="200000" />
7403e41df69e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
49 <param name="rangeDownstream" value="200000" />
7
ec40077337e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 8586409c5f329eaf75902eedc3d29a6e82560788
iuc
parents: 5
diff changeset
50 <output name="interactionFileNames" ftype="h5">
ec40077337e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 8586409c5f329eaf75902eedc3d29a6e82560788
iuc
parents: 5
diff changeset
51 <assert_contents>
ec40077337e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 8586409c5f329eaf75902eedc3d29a6e82560788
iuc
parents: 5
diff changeset
52 <has_h5_attribute key="averageContactBin" value="5" />
ec40077337e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 8586409c5f329eaf75902eedc3d29a6e82560788
iuc
parents: 5
diff changeset
53 <has_h5_attribute key="fixateRange" value="500000" />
ec40077337e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 8586409c5f329eaf75902eedc3d29a6e82560788
iuc
parents: 5
diff changeset
54 <!-- <has_h5_attribute key="range" value="200000,200000" /> -->
ec40077337e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 8586409c5f329eaf75902eedc3d29a6e82560788
iuc
parents: 5
diff changeset
55 <has_h5_attribute key="resolution" value="1000" />
ec40077337e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 8586409c5f329eaf75902eedc3d29a6e82560788
iuc
parents: 5
diff changeset
56 <has_h5_attribute key="type" value="interactions" />
ec40077337e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 8586409c5f329eaf75902eedc3d29a6e82560788
iuc
parents: 5
diff changeset
57 </assert_contents>
ec40077337e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 8586409c5f329eaf75902eedc3d29a6e82560788
iuc
parents: 5
diff changeset
58 </output>
3
544440b09b16 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit db84cc85222518217286b42262935edd3a49c98e"
iuc
parents: 2
diff changeset
59 </test>
0
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
60 </tests>
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
61 <help><![CDATA[
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
62
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
63 Compute viewpoints for all given reference points
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
64 =================================================
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
65
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
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
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
67 are named by the name of the reference point, the sample name and the location of the reference point:
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
68
1
7a659307d3ff "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 4b602d427e0fc0da5353a4510798349de98e4ae4"
iuc
parents: 0
diff changeset
69 gene_matrix_name_chr_start_end.txt
0
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
70
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
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
1
7a659307d3ff "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 4b602d427e0fc0da5353a4510798349de98e4ae4"
iuc
parents: 0
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
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
73
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
74 For more information about HiCExplorer please consider our documentation on readthedocs.io_
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
75
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
76 .. _readthedocs.io: http://hicexplorer.readthedocs.io/en/latest/index.html
5
7403e41df69e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 2a0943e78bdc8ebb13f181399206a9eea37ed78f"
iuc
parents: 3
diff changeset
77 ]]> </help>
0
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
78 <expand macro="citations" />
5d431baabba3 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents:
diff changeset
79 </tool>