annotate tools/regVariation/best_regression_subsets.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="BestSubsetsRegression1" name="Perform Best-subsets Regression">
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 best_regression_subsets.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 $out_file2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 1>/dev/null
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 2>/dev/null
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 </command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 <param format="tabular" name="input1" type="data" label="Select data" help="Dataset missing? See TIP below."/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 <param name="response_col" label="Response column (Y)" type="data_column" data_ref="input1" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 <param name="predictor_cols" label="Predictor columns (X)" type="data_column" data_ref="input1" multiple="true" >
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 <validator type="no_options" message="Please select at least one column."/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <data format="input" name="out_file1" metadata_source="input1" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 <data format="pdf" name="out_file2" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 <requirements>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 <requirement type="python-module">rpy</requirement>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 </requirements>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 <!-- Testing this tool will not be possible because this tool produces a pdf output file.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 -->
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 **TIP:** If your data is not TAB delimited, use *Edit Datasets-&gt;Convert characters*
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 **What it does**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 This tool uses the 'regsubsets' function from R statistical package for regression subset selection. It outputs two files, one containing a table with the best subsets and the corresponding summary statistics, and the other containing the graphical representation of the results.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47 .. class:: warningmark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 **Note**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 - This tool currently treats all predictor and response variables as continuous variables.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 - Rows containing non-numeric (or missing) data in any of the chosen columns will be skipped from the analysis.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55 - The 6 columns in the output are described below:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 - Column 1 (Vars): denotes the number of variables in the model
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58 - Column 2 ([c2 c3 c4...]): represents a list of the user-selected predictor variables (full model). An asterix denotes the presence of the corresponding predictor variable in the selected model.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 - Column 3 (R-sq): the fraction of variance explained by the model
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60 - Column 4 (Adj. R-sq): the above R-squared statistic adjusted, penalizing for higher number of predictors (p)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 - Column 5 (Cp): Mallow's Cp statistics
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62 - Column 6 (bic): Bayesian Information Criterion.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66 </tool>