annotate rcve.xml @ 0:d8c414b9d774 draft default tip

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