Mercurial > repos > malex > secimtools

annotate modulated_modularity_clustering.xml @ 2:caba07f41453 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/secimTools/SECIMTools/tree/main/galaxy commit 498abad641099412df56f04ff6e144e4193bbc34-dirty"
author malex
date Thu, 10 Jun 2021 15:41:17 +0000
parents 2e7d47c0b027
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
1 <tool id="secimtools_modulated_modularity_clustering" name="Modulated Modularity Clustering (MMC)" version="@WRAPPER_VERSION@">
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
2 <description>with visual summaries.</description>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
3 <macros>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
4 <import>macros.xml</import>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
5 </macros>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
6 <expand macro="requirements" />
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
8 modulated_modularity_clustering.py
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
9 --input $input
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
10 --design $design
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
11 --ID $uniqID
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
12 --out $output
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
13 --figure $figure
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
14 --sigmaLow $sigmaLow
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
15 --sigmaHigh $sigmaHigh
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
16 --sigmaNum $sigmaNum
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
17 --correlation $corr
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
18 ]]></command>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
19 <inputs>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
20 <param name="input" type="data" format="tabular" label="Wide Dataset" help="Input your tab-separated wide format dataset. If not tab separated see TIP below." />
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
21 <param name="design" type="data" format="tabular" label="Design Dataset" help="Input your design file (tab-separated). Note you need a 'sampleID' column. If not tab separated see TIP below."/>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
22 <param name="uniqID" type="text" size="30" label="Unique Feature ID" help="Name of the column in your wide dataset that has unique identifiers.." />
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
23 <param name="sigmaLow" type="float" size="6" value="0.05" label="Lower sigma bound" help="Default: 0.05." />
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
24 <param name="sigmaHigh" type="float" size="6" value="0.50" label="Upper sigma bound" help="Default: 0.50." />
2
caba07f41453 "planemo upload for repository https://github.com/secimTools/SECIMTools/tree/main/galaxy commit 498abad641099412df56f04ff6e144e4193bbc34-dirty"
malex
parents: 1
diff changeset
25 <param name="sigmaNum" type="integer" size="6" value="451" label="Number of Sigma values" help="Number of values of sigma to search. Default: 451." />
1
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
26 <param name="corr" type="select" value="pearson" label="Correlation method" help="Select correlation method for preliminary correlation before clustering. Default: Pearson." >
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
27 <option value="pearson" selected="true">Pearson</option>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
28 <option value="kendall" selected="true">Kendall</option>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
29 <option value="spearman" selected="true">Spearman</option>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
30 </param>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
31 </inputs>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
32 <outputs>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
33 <data format="tabular" name="output" label="${tool.name} on ${on_string}: Values"/>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
34 <data format="pdf" name="figure" label="${tool.name} on ${on_string}: Heatmaps"/>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
35 </outputs>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
36 <tests>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
37 <test>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
38 <param name="input" value="ST000006_data.tsv"/>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
39 <param name="design" value="ST000006_design.tsv"/>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
40 <param name="uniqID" value="Retention_Index" />
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
41 <param name="corr" value="pearson" />
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
42 <output name="output" file="ST000006_modulated_modularity_clustering_out.tsv" compare="sim_size" delta="10000"/>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
43 <output name="figure" file="ST000006_modulated_modularity_clustering_figure.pdf" compare="sim_size" delta="10000" />
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
44 </test>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
45 </tests>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
46 <help><![CDATA[
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
47
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
48 @TIP_AND_WARNING@
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
49
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
50 **Tool Description**
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
51
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
52 Modulated Modularity Clustering method (MMC) was designed to detect latent structure in data using weighted graphs.
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
53 The method searches for optimal community structure and detects the magnitude of pairwise relationships.
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
54 The optimal number of clusters and the optimal cluster size are selected by the method during the analysis.
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
55
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
56 The initial boundaries (lower and upper) for sigma as well as the number of points in the search grid (number of sigma values) are specified initially by the user.
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
57 The boundaries are extended automatically by the algorithm if the values are close to the boundary. The correlation type (Pearson, Kendall or Spearman) can be specified.
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
58
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
59 More details about the method can be found in:
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
60
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
61 Stone, E. A., and Ayroles, J. F. (2009). Modulated modularity clustering as an exploratory tool for functional genomic inference. PLoS Genet, 5(5), e1000479.
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
62
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
63
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
64 --------------------------------------------------------------------------------
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
65
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
66 **Input**
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
67
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
68 - Two input datasets are required.
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
69
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
70 @WIDE@
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
71
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
72 **NOTE:** The sample IDs must match the sample IDs in the Design File (below). Extra columns will automatically be ignored.
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
73
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
74 @METADATA@
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
75
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
76 @UNIQID@
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
77
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
78 **Lower sigma value**
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
79
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
80 - Default: 0.05.
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
81
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
82 **Upper sigma value**
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
83
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
84 - Default: 0.50.
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
85
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
86 **Sigma values**
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
87
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
88 - Number of values of sigma to search. Default: 451. Higher numbers increase the precision but decrease the performance time.
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
89
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
90 **Correlation method**
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
91
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
92 - Correlation method for preliminary correlation before clustering. Default = Pearson.
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
93
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
94 --------------------------------------------------------------------------------
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
95
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
96 **Output**
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
97
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
98 The tool produces four files: a single TSV file and three PDF files:
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
99
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
100 (1) a TSV file containing the algorithm summaries and
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
101 (2) three PDF files containing (i) unsorted, (ii) sorted, and (iii) sorted and smoothed dependency heatmaps produced by the MMC algorithm respectively.
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
102
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
103
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
104 ]]></help>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
105 <expand macro="citations"/>
2e7d47c0b027 "planemo upload for repository https://malex@toolshed.g2.bx.psu.edu/repos/malex/secimtools"
malex
parents:
diff changeset
106 </tool>