annotate pca.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="pca1" name="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 pca.py
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
10 $input1
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
11 $var_cols
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
12 $methodChoice.method
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
13 $out_file1
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
14 $out_file2
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
15 #if $methodChoice.method == "svd":
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
16 $methodChoice.scale
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
17 #end if
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
18 ]]>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
19 </command>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
20 <inputs>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
21 <param format="tabular" name="input1" type="data" label="Select data" help="Dataset missing? See TIP below."/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
22 <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
23 <validator type="no_options" message="Please select at least one column."/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
24 </param>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
25 <conditional name="methodChoice">
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
26 <param name="method" type="select" label="Method" help="The correlation matrix can only be used if there are no constant variables">
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
27 <option value="cor" selected="true">Eigenvectors of Correlation (princomp)</option>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
28 <option value="cov">Eigenvectors of Covariance (princomp)</option>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
29 <option value="svd">Singular Value Decomposition (prcomp)</option>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
30 </param>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
31 <when value="cor" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
32 <when value="cov" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
33 <when value="svd">
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
34 <param name="scale" type="select" label="Centering and Scaling" help="Can be used to center and/or scale variables">
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
35 <option value="none" selected="true">None</option>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
36 <option value="center">Center only</option>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
37 <option value="scale">Scale only</option>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
38 <option value="both">Center and Scale</option>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
39 </param>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
40 </when>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
41 </conditional>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
42 </inputs>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
43 <outputs>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
44 <data format="input" name="out_file1" metadata_source="input1" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
45 <data format="pdf" name="out_file2" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
46 </outputs>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
47 <tests>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
48 <test>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
49 <param name="input1" value="iris.tabular"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
50 <param name="var_cols" value="1,2,3,4"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
51 <param name="method" value="cor"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
52 <output name="out_file1" file="pca_out1.tabular"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
53 <output name="out_file2" file="pca_out2.pdf"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
54 </test>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
55 <test>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
56 <param name="input1" value="iris.tabular"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
57 <param name="var_cols" value="1,2,3,4"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
58 <param name="method" value="cov"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
59 <output name="out_file1" file="pca_out3.tabular"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
60 <output name="out_file2" file="pca_out4.pdf"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
61 </test>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
62 <test>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
63 <param name="input1" value="iris.tabular"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
64 <param name="var_cols" value="1,2,3,4"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
65 <param name="method" value="svd"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
66 <param name="scale" value="both"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
67 <output name="out_file1" file="pca_out5.tabular"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
68 <output name="out_file2" file="pca_out6.pdf"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
69 </test>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
70 </tests>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
71 <help>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
72 <![CDATA[
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
73
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
74
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
75 .. class:: infomark
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
76
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
77 **TIP:** If your data is not TAB delimited, use *Edit Datasets->Convert characters*
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
78
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
79 -----
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
80
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
81 .. class:: infomark
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
82
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
83 **What it does**
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
84
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
85 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.
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
86
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
87 *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.*
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
88
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
89 -----
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
90
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
91 .. class:: warningmark
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
92
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
93 **Note**
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
94
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
95 - 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
96
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
97 - The summary statistics in the output are described below:
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
98
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
99 - Std. deviation: Standard deviations of the principal components
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
100 - Loadings: a list of eigen-vectors/variable loadings
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
101 - Scores: Scores of the input data on the principal components
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
102
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
103 ]]>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
104 </help>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
105 </tool>