annotate tools/regVariation/rcve.xml @ 1:cdcb0ce84a1b

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:45:15 -0500
parents 9071e359b9a3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
1 <tool id="rcve1" name="Compute RCVE" version="1.0.0">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description> </description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <command interpreter="python">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 rcve.py
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 $input1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 $response_col
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 $predictor_cols
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 $out_file1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 1>/dev/null
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 </command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 <param format="tabular" name="input1" type="data" label="Select data" help="Dataset missing? See TIP below."/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 <param name="response_col" label="Response column (Y)" type="data_column" data_ref="input1" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 <param name="predictor_cols" label="Predictor columns (X)" type="data_column" data_ref="input1" multiple="true">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 <validator type="no_options" message="Please select at least one column."/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 <data format="input" name="out_file1" metadata_source="input1" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <requirements>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 <requirement type="python-module">rpy</requirement>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 </requirements>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 <!-- Test data with vlid values -->
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 <param name="input1" value="reg_inp.tab"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 <param name="response_col" value="1"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 <param name="predictor_cols" value="2,3,4"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 <output name="out_file1" file="rcve_out.dat"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 **TIP:** If your data is not TAB delimited, use *Edit Datasets-&gt;Convert characters*
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44 **What it does**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46 This tool computes the RCVE (Relative Contribution to Variance) for all possible variable subsets using the following formula:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48 **RCVE(i) = [R-sq (full: 1,2,..,i..,p-1) - R-sq(without i: 1,2,...,p-1)] / R-sq (full: 1,2,..,i..,p-1)**,
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 which denotes the case where the 'i'th predictor is dropped.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52 In general,
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 **RCVE(X+) = [R-sq (full: {X,X+}) - R-sq(reduced: {X})] / R-sq (full: {X,X+})**,
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54 where,
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56 - {X,X+} denotes the set of all predictors,
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 - X+ is the set of predictors for which we compute RCVE (and therefore drop from the full model to obtain a reduced one),
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58 - {X} is the set of the predictors that are left in the reduced model after excluding {X+}
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 The 4 columns in the output are described below:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63 - Column 1 (Model): denotes the variables present in the model ({X})
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64 - Column 2 (R-sq): denotes the R-squared value corresponding to the model in Column 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 - Column 3 (RCVE_Terms): denotes the variable/s for which RCVE is computed ({X+}). 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.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66 - Column 4 (RCVE): denotes the RCVE value corresponding to the variable/s in Column 3. A '-' in this column indicates that the model in Column 1 is the Full model.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70 </tool>