annotate kcca.xml @ 0:ffcdde989859 draft

Uploaded
author iuc
date Tue, 29 Jul 2014 06:30:45 -0400
parents
children 2e7bc1bb2dbe
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ffcdde989859 Uploaded
iuc
parents:
diff changeset
1 <tool id="kcca1" name="Kernel Canonical Correlation Analysis" version="1.1.0">
ffcdde989859 Uploaded
iuc
parents:
diff changeset
2 <description> </description>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
3 <expand macro="requirements" />
ffcdde989859 Uploaded
iuc
parents:
diff changeset
4 <macros>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
5 <import>statistic_tools_macros.xml</import>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
6 </macros>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
7 <command interpreter="python">
ffcdde989859 Uploaded
iuc
parents:
diff changeset
8 kcca.py
ffcdde989859 Uploaded
iuc
parents:
diff changeset
9 --input=$input1
ffcdde989859 Uploaded
iuc
parents:
diff changeset
10 --output1=$out_file1
ffcdde989859 Uploaded
iuc
parents:
diff changeset
11 --x_cols=$x_cols
ffcdde989859 Uploaded
iuc
parents:
diff changeset
12 --y_cols=$y_cols
ffcdde989859 Uploaded
iuc
parents:
diff changeset
13 --kernel=$kernelChoice.kernel
ffcdde989859 Uploaded
iuc
parents:
diff changeset
14 --features=$features
ffcdde989859 Uploaded
iuc
parents:
diff changeset
15 #if $kernelChoice.kernel == "rbfdot" or $kernelChoice.kernel == "anovadot":
ffcdde989859 Uploaded
iuc
parents:
diff changeset
16 --sigma=$kernelChoice.sigma
ffcdde989859 Uploaded
iuc
parents:
diff changeset
17 --degree="None"
ffcdde989859 Uploaded
iuc
parents:
diff changeset
18 --scale="None"
ffcdde989859 Uploaded
iuc
parents:
diff changeset
19 --offset="None"
ffcdde989859 Uploaded
iuc
parents:
diff changeset
20 --order="None"
ffcdde989859 Uploaded
iuc
parents:
diff changeset
21 #elif $kernelChoice.kernel == "polydot":
ffcdde989859 Uploaded
iuc
parents:
diff changeset
22 --sigma="None"
ffcdde989859 Uploaded
iuc
parents:
diff changeset
23 --degree=$kernelChoice.degree
ffcdde989859 Uploaded
iuc
parents:
diff changeset
24 --scale=$kernelChoice.scale
ffcdde989859 Uploaded
iuc
parents:
diff changeset
25 --offset=$kernelChoice.offset
ffcdde989859 Uploaded
iuc
parents:
diff changeset
26 --order="None"
ffcdde989859 Uploaded
iuc
parents:
diff changeset
27 #elif $kernelChoice.kernel == "tanhdot":
ffcdde989859 Uploaded
iuc
parents:
diff changeset
28 --sigma="None"
ffcdde989859 Uploaded
iuc
parents:
diff changeset
29 --degree="None"
ffcdde989859 Uploaded
iuc
parents:
diff changeset
30 --scale=$kernelChoice.scale
ffcdde989859 Uploaded
iuc
parents:
diff changeset
31 --offset=$kernelChoice.offset
ffcdde989859 Uploaded
iuc
parents:
diff changeset
32 --order="None"
ffcdde989859 Uploaded
iuc
parents:
diff changeset
33 #elif $kernelChoice.kernel == "besseldot":
ffcdde989859 Uploaded
iuc
parents:
diff changeset
34 --sigma=$kernelChoice.sigma
ffcdde989859 Uploaded
iuc
parents:
diff changeset
35 --degree=$kernelChoice.degree
ffcdde989859 Uploaded
iuc
parents:
diff changeset
36 --scale="None"
ffcdde989859 Uploaded
iuc
parents:
diff changeset
37 --offset="None"
ffcdde989859 Uploaded
iuc
parents:
diff changeset
38 --order=$kernelChoice.order
ffcdde989859 Uploaded
iuc
parents:
diff changeset
39 #elif $kernelChoice.kernel == "anovadot":
ffcdde989859 Uploaded
iuc
parents:
diff changeset
40 --sigma=$kernelChoice.sigma
ffcdde989859 Uploaded
iuc
parents:
diff changeset
41 --degree=$kernelChoice.degree
ffcdde989859 Uploaded
iuc
parents:
diff changeset
42 --scale="None"
ffcdde989859 Uploaded
iuc
parents:
diff changeset
43 --offset="None"
ffcdde989859 Uploaded
iuc
parents:
diff changeset
44 --order="None"
ffcdde989859 Uploaded
iuc
parents:
diff changeset
45 #else:
ffcdde989859 Uploaded
iuc
parents:
diff changeset
46 --sigma="None"
ffcdde989859 Uploaded
iuc
parents:
diff changeset
47 --degree="None"
ffcdde989859 Uploaded
iuc
parents:
diff changeset
48 --scale="None"
ffcdde989859 Uploaded
iuc
parents:
diff changeset
49 --offset="None"
ffcdde989859 Uploaded
iuc
parents:
diff changeset
50 --order="None"
ffcdde989859 Uploaded
iuc
parents:
diff changeset
51 #end if
ffcdde989859 Uploaded
iuc
parents:
diff changeset
52 </command>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
53 <inputs>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
54 <param format="tabular" name="input1" type="data" label="Select data" help="Dataset missing? See TIP below."/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
55 <param name="x_cols" label="Select columns containing X variables " type="data_column" data_ref="input1" numerical="True" multiple="true" >
ffcdde989859 Uploaded
iuc
parents:
diff changeset
56 <validator type="no_options" message="Please select at least one column."/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
57 </param>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
58 <param name="y_cols" label="Select columns containing Y variables " type="data_column" data_ref="input1" numerical="True" multiple="true" >
ffcdde989859 Uploaded
iuc
parents:
diff changeset
59 <validator type="no_options" message="Please select at least one column."/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
60 </param>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
61 <param name="features" size="10" type="integer" value="2" label="Number of canonical components to return" help="Enter an integer value greater than 0"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
62 <conditional name="kernelChoice">
ffcdde989859 Uploaded
iuc
parents:
diff changeset
63 <param name="kernel" type="select" label="Kernel function">
ffcdde989859 Uploaded
iuc
parents:
diff changeset
64 <option value="rbfdot" selected="true">Gaussian Radial Basis Function</option>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
65 <option value="polydot">Polynomial</option>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
66 <option value="vanilladot">Linear</option>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
67 <option value="tanhdot">Hyperbolic</option>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
68 <option value="laplacedot">Laplacian</option>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
69 <option value="besseldot">Bessel</option>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
70 <option value="anovadot">ANOVA Radial Basis Function</option>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
71 <option value="splinedot">Spline</option>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
72 </param>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
73 <when value="vanilladot" />
ffcdde989859 Uploaded
iuc
parents:
diff changeset
74 <when value="splinedot" />
ffcdde989859 Uploaded
iuc
parents:
diff changeset
75 <when value="rbfdot">
ffcdde989859 Uploaded
iuc
parents:
diff changeset
76 <param name="sigma" size="10" type="float" value="1" label="sigma (inverse kernel width)" />
ffcdde989859 Uploaded
iuc
parents:
diff changeset
77 </when>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
78 <when value="laplacedot">
ffcdde989859 Uploaded
iuc
parents:
diff changeset
79 <param name="sigma" size="10" type="float" value="1" label="sigma (inverse kernel width)" />
ffcdde989859 Uploaded
iuc
parents:
diff changeset
80 </when>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
81 <when value="polydot">
ffcdde989859 Uploaded
iuc
parents:
diff changeset
82 <param name="degree" size="10" type="float" value="1" label="degree" />
ffcdde989859 Uploaded
iuc
parents:
diff changeset
83 <param name="scale" size="10" type="float" value="1" label="scale" />
ffcdde989859 Uploaded
iuc
parents:
diff changeset
84 <param name="offset" size="10" type="float" value="1" label="offset" />
ffcdde989859 Uploaded
iuc
parents:
diff changeset
85 </when>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
86 <when value="tanhdot">
ffcdde989859 Uploaded
iuc
parents:
diff changeset
87 <param name="scale" size="10" type="float" value="1" label="scale" />
ffcdde989859 Uploaded
iuc
parents:
diff changeset
88 <param name="offset" size="10" type="float" value="1" label="offset" />
ffcdde989859 Uploaded
iuc
parents:
diff changeset
89 </when>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
90 <when value="besseldot">
ffcdde989859 Uploaded
iuc
parents:
diff changeset
91 <param name="sigma" size="10" type="float" value="1" label="sigma" />
ffcdde989859 Uploaded
iuc
parents:
diff changeset
92 <param name="order" size="10" type="float" value="1" label="order" />
ffcdde989859 Uploaded
iuc
parents:
diff changeset
93 <param name="degree" size="10" type="float" value="1" label="degree" />
ffcdde989859 Uploaded
iuc
parents:
diff changeset
94 </when>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
95 <when value="anovadot">
ffcdde989859 Uploaded
iuc
parents:
diff changeset
96 <param name="sigma" size="10" type="float" value="1" label="sigma" />
ffcdde989859 Uploaded
iuc
parents:
diff changeset
97 <param name="degree" size="10" type="float" value="1" label="degree" />
ffcdde989859 Uploaded
iuc
parents:
diff changeset
98 </when>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
99 </conditional>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
100 </inputs>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
101 <outputs>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
102 <data format="input" name="out_file1" metadata_source="input1" />
ffcdde989859 Uploaded
iuc
parents:
diff changeset
103 </outputs>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
104 <tests>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
105 <test>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
106 <param name="input1" value="iris.tabular"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
107 <param name="x_cols" value="1,2"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
108 <param name="y_cols" value="3,4"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
109 <param name="kernel" value="anovadot"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
110 <param name="features" value="4"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
111 <param name="sigma" value="0.1"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
112 <param name="degree" value="2"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
113 <output name="out_file1" file="kcca_out1.tabular" compare="re_match"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
114 </test>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
115 <test>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
116 <param name="input1" value="iris.tabular"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
117 <param name="x_cols" value="3,4"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
118 <param name="y_cols" value="1,2"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
119 <param name="kernel" value="rbfdot"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
120 <param name="features" value="2"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
121 <param name="sigma" value="0.5"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
122 <output name="out_file1" file="kcca_out2.tabular" compare="re_match"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
123 </test>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
124 </tests>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
125 <help>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
126
ffcdde989859 Uploaded
iuc
parents:
diff changeset
127
ffcdde989859 Uploaded
iuc
parents:
diff changeset
128 .. class:: infomark
ffcdde989859 Uploaded
iuc
parents:
diff changeset
129
ffcdde989859 Uploaded
iuc
parents:
diff changeset
130 **TIP:** If your data is not TAB delimited, use *Edit Datasets-&gt;Convert characters*
ffcdde989859 Uploaded
iuc
parents:
diff changeset
131
ffcdde989859 Uploaded
iuc
parents:
diff changeset
132 -----
ffcdde989859 Uploaded
iuc
parents:
diff changeset
133
ffcdde989859 Uploaded
iuc
parents:
diff changeset
134 .. class:: infomark
ffcdde989859 Uploaded
iuc
parents:
diff changeset
135
ffcdde989859 Uploaded
iuc
parents:
diff changeset
136 **What it does**
ffcdde989859 Uploaded
iuc
parents:
diff changeset
137
ffcdde989859 Uploaded
iuc
parents:
diff changeset
138 This tool uses functions from 'kernlab' library from R statistical package to perform Kernel Canonical Correlation Analysis (kCCA) on the input data.
ffcdde989859 Uploaded
iuc
parents:
diff changeset
139
ffcdde989859 Uploaded
iuc
parents:
diff changeset
140 *Alexandros Karatzoglou, Alex Smola, Kurt Hornik, Achim Zeileis (2004). kernlab - An S4 Package for Kernel Methods in R. Journal of Statistical Software 11(9), 1-20. URL http://www.jstatsoft.org/v11/i09/*
ffcdde989859 Uploaded
iuc
parents:
diff changeset
141
ffcdde989859 Uploaded
iuc
parents:
diff changeset
142 -----
ffcdde989859 Uploaded
iuc
parents:
diff changeset
143
ffcdde989859 Uploaded
iuc
parents:
diff changeset
144 .. class:: warningmark
ffcdde989859 Uploaded
iuc
parents:
diff changeset
145
ffcdde989859 Uploaded
iuc
parents:
diff changeset
146 **Note**
ffcdde989859 Uploaded
iuc
parents:
diff changeset
147
ffcdde989859 Uploaded
iuc
parents:
diff changeset
148 This tool currently treats all variables as continuous numeric variables. Running the tool on categorical variables might result in incorrect results. Rows containing non-numeric (or missing) data in any of the chosen columns will be skipped from the analysis.
ffcdde989859 Uploaded
iuc
parents:
diff changeset
149
ffcdde989859 Uploaded
iuc
parents:
diff changeset
150 </help>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
151 </tool>