annotate partialR_square.xml @ 90:b061185bcb83 draft

Uploaded
author bernhardlutz
date Thu, 23 Jan 2014 14:53:46 -0500
parents c4a3a8999945
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
80
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
1 <tool id="partialRsq" name="Compute partial R square" version="1.1.0">
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
2 <description> </description>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
3 <expand macro="requirements" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
4 <macros>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
5 <import>statistic_tools_macros.xml</import>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
6 </macros>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
7 <command interpreter="python">
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
8 partialR_square.py
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
9 $input1
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
10 $response_col
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
11 $predictor_cols
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
12 $out_file1
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
13 1>/dev/null
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
14 </command>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
15 <inputs>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
16 <param format="tabular" name="input1" type="data" label="Select data" help="Dataset missing? See TIP below."/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
17 <param name="response_col" label="Response column (Y)" type="data_column" data_ref="input1" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
18 <param name="predictor_cols" label="Predictor columns (X)" type="data_column" data_ref="input1" multiple="true">
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
19 <validator type="no_options" message="Please select at least one column."/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
20 </param>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
21 </inputs>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
22 <outputs>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
23 <data format="input" name="out_file1" metadata_source="input1" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
24 </outputs>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
25 <tests>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
26 <!-- Test data with vlid values -->
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
27 <test>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
28 <param name="input1" value="regr_inp.tabular"/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
29 <param name="response_col" value="3"/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
30 <param name="predictor_cols" value="1,2"/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
31 <output name="out_file1" file="partialR_result.tabular"/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
32 </test>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
33
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
34 </tests>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
35 <help>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
36
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
37 .. class:: infomark
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
38
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
39 **TIP:** If your data is not TAB delimited, use *Edit Datasets-&gt;Convert characters*
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
40
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
41 -----
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
42
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
43 .. class:: infomark
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
44
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
45 **What it does**
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
46
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
47 This tool computes the Partial R squared for all possible variable subsets using the following formula:
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
48
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
49 **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.
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
50
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
51
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
52
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
53 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,
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
54
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
55 - SSE (full: 1,2,..,i..,p-1) = Sum of Squares left out by the full set of predictors SSE(X1, X2 … Xp)
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
56 - 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).
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
57
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
58
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
59 The 4 columns in the output are described below:
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
60
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
61 - Column 1 (Model): denotes the variables present in the model
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
62 - Column 2 (R-sq): denotes the R-squared value corresponding to the model in Column 1
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
63 - 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.
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
64 - 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.
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
65
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
66 *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.*
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
67
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
68 </help>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
69 </tool>