annotate pca.xml @ 0:077ce468484f draft default tip

Imported from capsule None
author devteam
date Mon, 19 May 2014 11:00:07 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
1 <tool id="pca1" name="Principal Component Analysis" version="1.0.2">
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
2 <description> </description>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
3 <requirements>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
4 <requirement type="package" version="1.0.3">rpy</requirement>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
5 <requirement type="package" version="2.11.0">R</requirement>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
6 <requirement type="package" version="1.7.1">numpy</requirement>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
7 </requirements>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
8 <command interpreter="python">
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
9 pca.py
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
10 $input1
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
11 $var_cols
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
12 $methodChoice.method
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
13 $out_file1
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
14 $out_file2
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
15 #if $methodChoice.method == "svd":
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
16 $methodChoice.scale
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
17 #end if
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
18 </command>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
19 <inputs>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
20 <param format="tabular" name="input1" type="data" label="Select data" help="Dataset missing? See TIP below."/>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
21 <param name="var_cols" label="Select columns containing input variables " type="data_column" data_ref="input1" numerical="True" multiple="true" >
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
22 <validator type="no_options" message="Please select at least one column."/>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
23 </param>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
24 <conditional name="methodChoice">
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
25 <param name="method" type="select" label="Method" help="The correlation matrix can only be used if there are no constant variables">
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
26 <option value="cor" selected="true">Eigenvectors of Correlation (princomp)</option>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
27 <option value="cov">Eigenvectors of Covariance (princomp)</option>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
28 <option value="svd">Singular Value Decomposition (prcomp)</option>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
29 </param>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
30 <when value="cor" />
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
31 <when value="cov" />
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
32 <when value="svd">
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
33 <param name="scale" type="select" label="Centering and Scaling" help="Can be used to center and/or scale variables">
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
34 <option value="none" selected="true">None</option>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
35 <option value="center">Center only</option>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
36 <option value="scale">Scale only</option>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
37 <option value="both">Center and Scale</option>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
38 </param>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
39 </when>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
40 </conditional>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
41 </inputs>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
42 <outputs>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
43 <data format="input" name="out_file1" metadata_source="input1" />
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
44 <data format="pdf" name="out_file2" />
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
45 </outputs>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
46 <tests>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
47 <test>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
48 <param name="input1" value="iris.tabular"/>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
49 <param name="var_cols" value="1,2,3,4"/>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
50 <param name="method" value="cor"/>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
51 <output name="out_file1" file="pca_out1.tabular"/>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
52 <output name="out_file2" file="pca_out2.pdf"/>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
53 </test>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
54 <test>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
55 <param name="input1" value="iris.tabular"/>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
56 <param name="var_cols" value="1,2,3,4"/>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
57 <param name="method" value="cov"/>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
58 <output name="out_file1" file="pca_out3.tabular"/>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
59 <output name="out_file2" file="pca_out4.pdf"/>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
60 </test>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
61 <test>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
62 <param name="input1" value="iris.tabular"/>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
63 <param name="var_cols" value="1,2,3,4"/>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
64 <param name="method" value="svd"/>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
65 <param name="scale" value="both"/>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
66 <output name="out_file1" file="pca_out5.tabular"/>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
67 <output name="out_file2" file="pca_out6.pdf"/>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
68 </test>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
69 </tests>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
70 <help>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
71
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
72
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
73 .. class:: infomark
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
74
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
75 **TIP:** If your data is not TAB delimited, use *Edit Datasets-&gt;Convert characters*
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
76
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
77 -----
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
78
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
79 .. class:: infomark
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
80
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
81 **What it does**
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
82
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
83 This tool performs Principal Component Analysis on the given numeric input data using functions from R statistical package - 'princomp' function (for Eigenvector based solution) and 'prcomp' function (for Singular value decomposition based solution). It outputs two files, one containing the summary statistics of PCA, and the other containing biplots of the observations and principal components.
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
84
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
85 *R Development Core Team (2009). R: A language and environment for statistical computing. R Foundation for Statistical Computing, Vienna, Austria. ISBN 3-900051-07-0, URL http://www.R-project.org.*
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
86
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
87 -----
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
88
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
89 .. class:: warningmark
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
90
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
91 **Note**
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
92
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
93 - 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.
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
94
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
95 - The summary statistics in the output are described below:
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
96
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
97 - Std. deviation: Standard deviations of the principal components
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
98 - Loadings: a list of eigen-vectors/variable loadings
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
99 - Scores: Scores of the input data on the principal components
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
100
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
101 </help>
077ce468484f Imported from capsule None
devteam
parents:
diff changeset
102 </tool>