annotate partialR_square.xml @ 0:88ef41de020d draft default tip

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