Mercurial > repos > iuc > schicexplorer_schicclustersvl

annotate scHicClusterSVL.xml @ 1:eeb26f378f34 draft

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/schicexplorer commit 72e1e90ac05a32dbd6fc675073429c0086048b18"
author iuc
date Tue, 10 Mar 2020 15:08:53 -0400
parents 7cbd84a1f985
children e6ec3914a076
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
1 <tool id="schicexplorer_schicclustersvl" name="@BINARY@" version="@WRAPPER_VERSION@.0">
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
2 <description>clusters single-cell Hi-C interaction matrices with svl dimension reduction</description>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
3 <macros>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
4 <token name="@BINARY@">scHicClusterSVL</token>
7cbd84a1f985 "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>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
6 </macros>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
7 <expand macro="requirements" />
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
9 @BINARY@
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
10
1
eeb26f378f34 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 72e1e90ac05a32dbd6fc675073429c0086048b18"
iuc
parents: 0
diff changeset
11 --matrix '$matrix_scooler'
0
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
12
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
13 --numberOfClusters $numberOfClusters
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
14 --distanceShortRange $distanceShortRange
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
15 --distanceLongRange $distanceLongRange
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
16
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
17 --clusterMethod $clusterMethod_selector
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
18
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
19 #if $chromosomes:
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
20 #set $chromosome = ' '.join([ '\'%s\'' % $chrom for $chrom in str($chromosomes).split(' ') ])
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
21 --chromosomes $chromosome
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
22 #end if
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
23
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
24 --outFileName cluster_list.txt
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
25
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
26 --threads @THREADS@
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
27 ]]></command>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
28 <inputs>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
29
1
eeb26f378f34 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 72e1e90ac05a32dbd6fc675073429c0086048b18"
iuc
parents: 0
diff changeset
30 <expand macro="matrix_scooler_macro"/>
0
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
31 <param name="clusterMethod_selector" type="select" label="Cluster method:">
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
32 <option value="kmeans" selected="True">K-means</option>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
33 <option value="spectral" >Spectral clustering</option>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
34 </param>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
35
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
36 <param name="numberOfClusters" type="integer" value="7" label="Number of clusters" help='How many clusters should be computed by kmeans or spectral clustering' />
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
37 <param name="distanceShortRange" type="integer" value="2000000" label="Distance short range" help='Distance for the short range to compute the ratio of sum (short range interactions) / sum (long range interactions)' />
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
38 <param name="distanceLongRange" type="integer" value="12000000" label="Distance long range" help='Distance for the long range to compute the ratio of sum (short range interactions) / sum (long range interactions)' />
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
39
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
40 <param name='chromosomes' type='text' label='List of chromosomes to consider' help='Please separate the chromosomes by space'/>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
41 </inputs>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
42 <outputs>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
43 <data name="outFileName" from_work_dir="cluster_list.txt" format="txt" label="${tool.name} on ${on_string}: Cluster results"/>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
44 </outputs>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
45 <tests>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
46 <test>
1
eeb26f378f34 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 72e1e90ac05a32dbd6fc675073429c0086048b18"
iuc
parents: 0
diff changeset
47 <param name='matrix_scooler' value='test_matrix.scool' />
0
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
48 <param name='clusterMethod_selector' value='kmeans' />
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
49 <param name='numberOfClusters' value='3' />
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
50 <param name='distanceShortRange' value='2000000' />
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
51 <param name='distanceLongRange' value='12000000' />
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
52
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
53 <output name="outFileName" file="scHicClusterSVL/cluster_kmeans.txt" ftype="txt" compare="sim_size" delta="4000"/>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
54 </test>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
55
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
56 <test>
1
eeb26f378f34 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 72e1e90ac05a32dbd6fc675073429c0086048b18"
iuc
parents: 0
diff changeset
57 <param name='matrix_scooler' value='test_matrix.scool' />
0
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
58 <param name='clusterMethod_selector' value='spectral' />
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
59 <param name='numberOfClusters' value='3' />
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
60 <param name='distanceShortRange' value='2000000' />
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
61 <param name='distanceLongRange' value='12000000' />
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
62
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
63 <output name="outFileName" file="scHicClusterSVL/cluster_spectral.txt" ftype="txt" compare="sim_size" delta="4000"/>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
64 </test>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
65
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
66 </tests>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
67 <help><![CDATA[
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
68
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
69 Clustering with dimension reduction via short vs long range ratio
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
70 =================================================================
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
71
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
72 scHicClusterSVL uses kmeans or spectral clustering to associate each cell to a cluster and therefore to its cell cycle.
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
73 The clustering is applied on dimension reduced data based on the ratio of short vs long range contacts per chromosome. This approach reduces the number of dimensions from samples * (number of bins)^2 to samples * (number of chromosomes).
1
eeb26f378f34 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 72e1e90ac05a32dbd6fc675073429c0086048b18"
iuc
parents: 0
diff changeset
74 Please consider also the other clustering and dimension reduction approaches of the scHicExplorer suite such as `scHicCluster`, `scHicClusterMinHash` and `scHicClusterSVL`. They can give you better results,
0
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
75 can be faster or less memory demanding.
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
76
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
77 For more information about scHiCExplorer please consider our documentation on readthedocs.io_
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
78
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
79 .. _readthedocs.io: http://schicexplorer.readthedocs.io/
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
80 ]]></help>
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
81 <expand macro="citations" />
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
82
7cbd84a1f985 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/schicexplorer commit 2a80f777c0221752232882c0d43b55f2b1dcd223"
iuc
parents:
diff changeset
83 </tool>