annotate partialR_square.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="partialRsq" name="Compute partial R square" 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 partialR_square.py
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
10 $input1
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
11 $response_col
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
12 $predictor_cols
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
13 $out_file1
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
14 1>/dev/null
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
15 ]]>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
16 </command>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
17 <inputs>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
18 <param format="tabular" name="input1" type="data" label="Select data" help="Dataset missing? See TIP below."/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
19 <param name="response_col" label="Response column (Y)" type="data_column" data_ref="input1" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
20 <param name="predictor_cols" label="Predictor columns (X)" type="data_column" data_ref="input1" multiple="true">
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
21 <validator type="no_options" message="Please select at least one column."/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
22 </param>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
23 </inputs>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
24 <outputs>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
25 <data format="input" name="out_file1" metadata_source="input1" />
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
26 </outputs>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
27 <tests>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
28 <!-- Test data with vlid values -->
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
29 <test>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
30 <param name="input1" value="regr_inp.tabular"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
31 <param name="response_col" value="3"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
32 <param name="predictor_cols" value="1,2"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
33 <output name="out_file1" file="partialR_result.tabular"/>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
34 </test>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
35
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
36 </tests>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
37 <help>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
38 <![CDATA[
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
39
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
40 .. class:: infomark
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
41
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
42 **TIP:** If your data is not TAB delimited, use *Edit Datasets->Convert characters*
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
43
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
44 -----
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
45
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
46 .. class:: infomark
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
47
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
48 **What it does**
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
49
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
50 This tool computes the Partial R squared for all possible variable subsets using the following formula:
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
51
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
52 **Partial R squared = [SSE(without i: 1,2,...,p-1) - SSE (full: 1,2,..,i..,p-1) / SSE(without i: 1,2,...,p-1)]**, which denotes the case where the 'i'th predictor is dropped.
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
53
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
54
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
55
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
56 In general, **Partial R squared = [SSE(without i: 1,2,...,p-1) - SSE (full: 1,2,..,i..,p-1) / SSE(without i: 1,2,...,p-1)]**, where,
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
57
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
58 - SSE (full: 1,2,..,i..,p-1) = Sum of Squares left out by the full set of predictors SSE(X1, X2 … Xp)
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
59 - SSE (full: 1,2,..,i..,p-1) = Sum of Squares left out by the set of predictors excluding; for example, if we omit the first predictor, it will be SSE(X2 … Xp).
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
60
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
61
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
62 The 4 columns in the output are described below:
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
63
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
64 - Column 1 (Model): denotes the variables present in the model
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
65 - Column 2 (R-sq): denotes the R-squared value corresponding to the model in Column 1
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
66 - Column 3 (Partial R squared_Terms): denotes the variable/s for which Partial R squared is computed. These are the variables that are absent in the reduced model in Column 1. A '-' in this column indicates that the model in Column 1 is the Full model.
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
67 - Column 4 (Partial R squared): denotes the Partial R squared value corresponding to the variable/s in Column 3. A '-' in this column indicates that the model in Column 1 is the Full model.
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
68
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
69 *R Development Core Team (2010). 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
70
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
71 ]]>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
72 </help>
2e7bc1bb2dbe Uploaded
iuc
parents: 0
diff changeset
73 </tool>