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