annotate kpca.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="kpca1" name="Kernel Principal Component 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 kpca.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 --output2=$out_file2
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
13 --var_cols=$var_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="var_cols" label="Select columns containing input 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="features" size="10" type="integer" value="2" label="Number of principal components to return" help="To return all, enter 0"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
61 <conditional name="kernelChoice">
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
62 <param name="kernel" type="select" label="Kernel function">
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
63 <option value="rbfdot" selected="true">Gaussian Radial Basis Function</option>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
64 <option value="polydot">Polynomial</option>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
65 <option value="vanilladot">Linear</option>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
66 <option value="tanhdot">Hyperbolic</option>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
67 <option value="laplacedot">Laplacian</option>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
68 <option value="besseldot">Bessel</option>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
69 <option value="anovadot">ANOVA Radial Basis Function</option>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
70 <option value="splinedot">Spline</option>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
71 </param>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
72 <when value="vanilladot" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
73 <when value="splinedot" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
74 <when value="rbfdot">
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
75 <param name="sigma" size="10" type="float" value="1" label="sigma (inverse kernel width)" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
76 </when>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
77 <when value="laplacedot">
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="polydot">
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
81 <param name="degree" size="10" type="integer" value="1" label="degree" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
82 <param name="scale" size="10" type="integer" value="1" label="scale" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
83 <param name="offset" size="10" type="integer" value="1" label="offset" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
84 </when>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
85 <when value="tanhdot">
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
86 <param name="scale" size="10" type="integer" value="1" label="scale" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
87 <param name="offset" size="10" type="integer" value="1" label="offset" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
88 </when>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
89 <when value="besseldot">
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
90 <param name="sigma" size="10" type="integer" value="1" label="sigma" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
91 <param name="order" size="10" type="integer" value="1" label="order" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
92 <param name="degree" size="10" type="integer" value="1" label="degree" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
93 </when>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
94 <when value="anovadot">
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
95 <param name="sigma" size="10" type="integer" value="1" label="sigma" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
96 <param name="degree" size="10" type="integer" value="1" label="degree" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
97 </when>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
98 </conditional>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
99 </inputs>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
100 <outputs>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
101 <data format="input" name="out_file1" metadata_source="input1" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
102 <data format="pdf" name="out_file2" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
103 </outputs>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
104 <tests>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
105 <test>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
106 <param name="input1" value="iris.tabular"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
107 <param name="var_cols" value="1,2,3,4"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
108 <param name="kernel" value="polydot"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
109 <param name="features" value="2"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
110 <param name="offset" value="0"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
111 <param name="scale" value="1"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
112 <param name="degree" value="2"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
113 <output name="out_file1" file="kpca_out1.tabular"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
114 <output name="out_file2" file="kpca_out2.pdf"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
115 </test>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
116 </tests>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
117 <help>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
118 <![CDATA[
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
119
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
120
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
121 .. class:: infomark
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
122
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
123 **TIP:** If your data is not TAB delimited, use *Edit Datasets->Convert characters*
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
124
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
125 -----
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
126
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
127 .. class:: infomark
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
128
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
129 **What it does**
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
130
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
131 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.
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
132
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
133 *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
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:: warningmark
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
138
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
139 **Note**
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
140
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
141 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
142
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
143 ]]>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
144 </help>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
145 </tool>