annotate kcca.xml @ 0:f89438602243 draft

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