annotate tools/multivariate_stats/kpca.xml @ 1:cdcb0ce84a1b

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