annotate kpca.xml @ 82:057169fb41c7 draft

Uploaded
author bernhardlutz
date Mon, 20 Jan 2014 15:08:40 -0500
parents c4a3a8999945
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
80
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
1 <tool id="kpca1" name="Kernel Principal Component Analysis" version="1.1.0">
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
2 <description> </description>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
3 <expand macro="requirements" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
4 <macros>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
5 <import>statistic_tools_macros.xml</import>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
6 </macros>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
7 <command interpreter="python">
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
8 kpca.py
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
9 --input=$input1
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
10 --output1=$out_file1
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
11 --output2=$out_file2
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
12 --var_cols=$var_cols
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
13 --kernel=$kernelChoice.kernel
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
14 --features=$features
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
15 #if $kernelChoice.kernel == "rbfdot" or $kernelChoice.kernel == "anovadot":
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
16 --sigma=$kernelChoice.sigma
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
17 --degree="None"
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
18 --scale="None"
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
19 --offset="None"
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
20 --order="None"
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
21 #elif $kernelChoice.kernel == "polydot":
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
22 --sigma="None"
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
23 --degree=$kernelChoice.degree
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
24 --scale=$kernelChoice.scale
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
25 --offset=$kernelChoice.offset
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
26 --order="None"
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
27 #elif $kernelChoice.kernel == "tanhdot":
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
28 --sigma="None"
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
29 --degree="None"
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
30 --scale=$kernelChoice.scale
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
31 --offset=$kernelChoice.offset
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
32 --order="None"
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
33 #elif $kernelChoice.kernel == "besseldot":
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
34 --sigma=$kernelChoice.sigma
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
35 --degree=$kernelChoice.degree
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
36 --scale="None"
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
37 --offset="None"
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
38 --order=$kernelChoice.order
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
39 #elif $kernelChoice.kernel == "anovadot":
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
40 --sigma=$kernelChoice.sigma
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
41 --degree=$kernelChoice.degree
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
42 --scale="None"
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
43 --offset="None"
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
44 --order="None"
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
45 #else:
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
46 --sigma="None"
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
47 --degree="None"
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
48 --scale="None"
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
49 --offset="None"
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
50 --order="None"
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
51 #end if
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
52 </command>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
53 <inputs>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
54 <param format="tabular" name="input1" type="data" label="Select data" help="Dataset missing? See TIP below."/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
55 <param name="var_cols" label="Select columns containing input variables " type="data_column" data_ref="input1" numerical="True" multiple="true" >
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
56 <validator type="no_options" message="Please select at least one column."/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
57 </param>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
58 <param name="features" size="10" type="integer" value="2" label="Number of principal components to return" help="To return all, enter 0"/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
59 <conditional name="kernelChoice">
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
60 <param name="kernel" type="select" label="Kernel function">
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
61 <option value="rbfdot" selected="true">Gaussian Radial Basis Function</option>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
62 <option value="polydot">Polynomial</option>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
63 <option value="vanilladot">Linear</option>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
64 <option value="tanhdot">Hyperbolic</option>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
65 <option value="laplacedot">Laplacian</option>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
66 <option value="besseldot">Bessel</option>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
67 <option value="anovadot">ANOVA Radial Basis Function</option>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
68 <option value="splinedot">Spline</option>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
69 </param>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
70 <when value="vanilladot" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
71 <when value="splinedot" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
72 <when value="rbfdot">
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
73 <param name="sigma" size="10" type="float" value="1" label="sigma (inverse kernel width)" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
74 </when>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
75 <when value="laplacedot">
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
76 <param name="sigma" size="10" type="float" value="1" label="sigma (inverse kernel width)" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
77 </when>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
78 <when value="polydot">
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
79 <param name="degree" size="10" type="integer" value="1" label="degree" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
80 <param name="scale" size="10" type="integer" value="1" label="scale" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
81 <param name="offset" size="10" type="integer" value="1" label="offset" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
82 </when>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
83 <when value="tanhdot">
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
84 <param name="scale" size="10" type="integer" value="1" label="scale" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
85 <param name="offset" size="10" type="integer" value="1" label="offset" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
86 </when>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
87 <when value="besseldot">
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
88 <param name="sigma" size="10" type="integer" value="1" label="sigma" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
89 <param name="order" size="10" type="integer" value="1" label="order" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
90 <param name="degree" size="10" type="integer" value="1" label="degree" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
91 </when>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
92 <when value="anovadot">
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
93 <param name="sigma" size="10" type="integer" value="1" label="sigma" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
94 <param name="degree" size="10" type="integer" value="1" label="degree" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
95 </when>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
96 </conditional>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
97 </inputs>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
98 <outputs>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
99 <data format="input" name="out_file1" metadata_source="input1" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
100 <data format="pdf" name="out_file2" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
101 </outputs>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
102 <tests>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
103 <test>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
104 <param name="input1" value="iris.tabular"/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
105 <param name="var_cols" value="1,2,3,4"/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
106 <param name="kernel" value="polydot"/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
107 <param name="features" value="2"/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
108 <param name="offset" value="0"/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
109 <param name="scale" value="1"/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
110 <param name="degree" value="2"/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
111 <output name="out_file1" file="kpca_out1.tabular"/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
112 <output name="out_file2" file="kpca_out2.pdf"/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
113 </test>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
114 </tests>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
115 <help>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
116
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
117
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
118 .. class:: infomark
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
119
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
120 **TIP:** If your data is not TAB delimited, use *Edit Datasets-&gt;Convert characters*
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
121
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
122 -----
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
123
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
124 .. class:: infomark
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
125
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
126 **What it does**
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
127
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
128 This tool uses functions from 'kernlab' library from R statistical package to perform Kernel Principal Component Analysis (kPCA) on the input data. It outputs two files, one containing the summary statistics of the performed kPCA, and the other containing a scatterplot matrix of rotated values reported by kPCA.
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
129
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
130 *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/*
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
131
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
132 -----
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
133
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
134 .. class:: warningmark
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
135
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
136 **Note**
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
137
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
138 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.
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
139
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
140 </help>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
141 </tool>