annotate scHicPlotConsensusMatrices.xml @ 3:b1f0a9b02efd draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit c535679b4086f5bd1a75e9765b8708bf1bd2d81b
author iuc
date Thu, 31 Jul 2025 16:45:18 +0000
parents 95b1216e1e70
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
95b1216e1e70 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit d350f8e73ae518245a21f9720f8282f06eb9cc5d
iuc
parents: 1
diff changeset
1 <tool id="schicexplorer_schicplotconsensusmatrices" name="@BINARY@" version="@TOOL_VERSION@.1" profile="@PROFILE@">
0
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
2 <description>plot single-cell Hi-C interaction matrices cluster consensus matrices</description>
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
3 <macros>
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
4 <token name="@BINARY@">scHicPlotConsensusMatrices</token>
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
5 <import>macros.xml</import>
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
6 </macros>
3
b1f0a9b02efd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit c535679b4086f5bd1a75e9765b8708bf1bd2d81b
iuc
parents: 2
diff changeset
7 <expand macro="xrefs"/>
0
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
8 <expand macro="requirements" />
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
9 <command detect_errors="exit_code"><![CDATA[
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
10 @BINARY@
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
11
1
259899fbb6ae "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 72e1e90ac05a32dbd6fc675073429c0086048b18"
iuc
parents: 0
diff changeset
12 --matrix $matrix_scooler
0
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
13 #if $chromosomes:
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
14 #set $chromosome = ' '.join([ '\'%s\'' % $chrom for $chrom in str($chromosomes).split(' ') ])
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
15 --chromosomes $chromosome
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
16 #end if
3
b1f0a9b02efd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit c535679b4086f5bd1a75e9765b8708bf1bd2d81b
iuc
parents: 2
diff changeset
17
0
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
18 #if $colormap:
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
19 --colorMap $colormap
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
20 #end if
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
21 #if $dpi:
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
22 --dpi $dpi
3
b1f0a9b02efd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit c535679b4086f5bd1a75e9765b8708bf1bd2d81b
iuc
parents: 2
diff changeset
23 #end if
0
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
24 --outFileName plot.$image_file_format
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
25
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
26 --threads @THREADS@
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
27
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
28 && mv plot.$image_file_format plot
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
29
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
30 ]]></command>
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
31 <inputs>
1
259899fbb6ae "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 72e1e90ac05a32dbd6fc675073429c0086048b18"
iuc
parents: 0
diff changeset
32 <expand macro="matrix_scooler_macro"/>
0
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
33 <param name='chromosomes' type='text' label='List of chromosomes to consider' help='Please separate the chromosomes by space'/>
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
34 <expand macro="colormap" />
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
35 <param name='dpi' type='integer' label='DPI for image' help='Change the default resolution of the plot.' optional='true'/>
3
b1f0a9b02efd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit c535679b4086f5bd1a75e9765b8708bf1bd2d81b
iuc
parents: 2
diff changeset
36
0
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
37 <param name="image_file_format" type="select" label="Image output format">
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
38 <option value="png" selected="True">png</option>
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
39 <option value="svg">svg</option>
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
40 <option value="pdf">pdf</option>
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
41 </param>
3
b1f0a9b02efd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit c535679b4086f5bd1a75e9765b8708bf1bd2d81b
iuc
parents: 2
diff changeset
42
0
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
43 </inputs>
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
44 <outputs>
1
259899fbb6ae "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 72e1e90ac05a32dbd6fc675073429c0086048b18"
iuc
parents: 0
diff changeset
45 <data name='output_plot' from_work_dir='plot' format='png' label='Consensus matrix plot on ${on_string}'>
0
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
46 <change_format>
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
47 <when input="image_file_format" value="svg" format="svg" />
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
48 <when input="image_file_format" value="pdf" format="pdf" />
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
49 </change_format>
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
50 </data>
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
51 </outputs>
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
52 <tests>
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
53 <test>
1
259899fbb6ae "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 72e1e90ac05a32dbd6fc675073429c0086048b18"
iuc
parents: 0
diff changeset
54 <param name='matrix_scooler' value='scHicConsensusMatrices/consensus_matrix.scool' />
0
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
55 <param name="image_file_format" value="png" />
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
56 <param name="dpi" value="300" />
3
b1f0a9b02efd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit c535679b4086f5bd1a75e9765b8708bf1bd2d81b
iuc
parents: 2
diff changeset
57 <output name="output_plot" file="scHicPlotConsensusMatrices/plot.png" ftype="png" compare="sim_size" delta="35000"/>
0
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
58 </test>
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
59 <test>
1
259899fbb6ae "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 72e1e90ac05a32dbd6fc675073429c0086048b18"
iuc
parents: 0
diff changeset
60 <param name='matrix_scooler' value='scHicConsensusMatrices/consensus_matrix.scool' />
0
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
61 <param name="image_file_format" value="png" />
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
62 <param name="dpi" value="300" />
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
63 <param name="chromosomes" value="chr1 chr2" />
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
64
3
b1f0a9b02efd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit c535679b4086f5bd1a75e9765b8708bf1bd2d81b
iuc
parents: 2
diff changeset
65 <output name="output_plot" file="scHicPlotConsensusMatrices/plot_chr1_chr2.png" ftype="png" compare="sim_size" delta="35000"/>
0
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
66 </test>
3
b1f0a9b02efd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit c535679b4086f5bd1a75e9765b8708bf1bd2d81b
iuc
parents: 2
diff changeset
67
0
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
68 </tests>
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
69 <help><![CDATA[
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
70
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
71 Plot consensus matrices
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
72 =======================
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
73
1
259899fbb6ae "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 72e1e90ac05a32dbd6fc675073429c0086048b18"
iuc
parents: 0
diff changeset
74 scHicPlotConsensusMatrices plots the consensus (average) matrix of a cluster. This tool is useful to compare the single cell clusters.
0
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
75
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
76 .. image:: $PATH_TO_IMAGES/consensus_svl_spectral.png
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
77 :width: 50%
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
78
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
79 For more information about scHiCExplorer please consider our documentation on readthedocs.io_
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
80
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
81 .. _readthedocs.io: http://schicexplorer.readthedocs.io/
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
82 ]]></help>
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
83 <expand macro="citations" />
1a1e085c352e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
84
3
b1f0a9b02efd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit c535679b4086f5bd1a75e9765b8708bf1bd2d81b
iuc
parents: 2
diff changeset
85 </tool>