annotate kcca.xml @ 1:2e7bc1bb2dbe draft default tip

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