annotate logistic_regression_vif.xml @ 0:ffcdde989859 draft

Uploaded
author iuc
date Tue, 29 Jul 2014 06:30:45 -0400
parents
children 2e7bc1bb2dbe
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ffcdde989859 Uploaded
iuc
parents:
diff changeset
1 <tool id="LogisticRegression" name="Perform Logistic Regression with vif" version="1.1.0">
ffcdde989859 Uploaded
iuc
parents:
diff changeset
2 <description> </description>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
3 <expand macro="requirements" />
ffcdde989859 Uploaded
iuc
parents:
diff changeset
4 <macros>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
5 <import>statistic_tools_macros.xml</import>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
6 </macros>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
7 <command interpreter="python">
ffcdde989859 Uploaded
iuc
parents:
diff changeset
8 logistic_regression_vif.py
ffcdde989859 Uploaded
iuc
parents:
diff changeset
9 $input1
ffcdde989859 Uploaded
iuc
parents:
diff changeset
10 $response_col
ffcdde989859 Uploaded
iuc
parents:
diff changeset
11 $predictor_cols
ffcdde989859 Uploaded
iuc
parents:
diff changeset
12 $out_file1
ffcdde989859 Uploaded
iuc
parents:
diff changeset
13 1>/dev/null
ffcdde989859 Uploaded
iuc
parents:
diff changeset
14 </command>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
15 <inputs>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
16 <param format="tabular" name="input1" type="data" label="Select data" help="Dataset missing? See TIP below."/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
17 <param name="response_col" label="Response column (Y)" type="data_column" data_ref="input1" numerical="True"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
18 <param name="predictor_cols" label="Predictor columns (X)" type="data_column" data_ref="input1" numerical="True" multiple="true" >
ffcdde989859 Uploaded
iuc
parents:
diff changeset
19 <validator type="no_options" message="Please select at least one column."/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
20 </param>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
21 </inputs>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
22 <outputs>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
23 <data format="input" name="out_file1" metadata_source="input1" />
ffcdde989859 Uploaded
iuc
parents:
diff changeset
24
ffcdde989859 Uploaded
iuc
parents:
diff changeset
25 </outputs>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
26 <tests>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
27 <test>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
28 <param name="input1" value="logreg_inp.tabular"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
29 <param name="response_col" value="4"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
30 <param name="predictor_cols" value="1,2,3"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
31 <output name="out_file1" file="logreg_out2.tabular"/>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
32
ffcdde989859 Uploaded
iuc
parents:
diff changeset
33 </test>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
34 </tests>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
35 <help>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
36
ffcdde989859 Uploaded
iuc
parents:
diff changeset
37
ffcdde989859 Uploaded
iuc
parents:
diff changeset
38 .. class:: infomark
ffcdde989859 Uploaded
iuc
parents:
diff changeset
39
ffcdde989859 Uploaded
iuc
parents:
diff changeset
40 **TIP:** If your data is not TAB delimited, use *Edit Datasets-&gt;Convert characters*
ffcdde989859 Uploaded
iuc
parents:
diff changeset
41
ffcdde989859 Uploaded
iuc
parents:
diff changeset
42 -----
ffcdde989859 Uploaded
iuc
parents:
diff changeset
43
ffcdde989859 Uploaded
iuc
parents:
diff changeset
44 .. class:: infomark
ffcdde989859 Uploaded
iuc
parents:
diff changeset
45
ffcdde989859 Uploaded
iuc
parents:
diff changeset
46 **What it does**
ffcdde989859 Uploaded
iuc
parents:
diff changeset
47
ffcdde989859 Uploaded
iuc
parents:
diff changeset
48 This tool uses the **'glm'** function from R statistical package to perform logistic regression on the input data. It outputs one file containing the summary statistics of the performed regression. Also, it calculates VIF(Variance Inflation Factor) with **'vif'** function from library (car) in R.
ffcdde989859 Uploaded
iuc
parents:
diff changeset
49
ffcdde989859 Uploaded
iuc
parents:
diff changeset
50
ffcdde989859 Uploaded
iuc
parents:
diff changeset
51 *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.*
ffcdde989859 Uploaded
iuc
parents:
diff changeset
52
ffcdde989859 Uploaded
iuc
parents:
diff changeset
53 -----
ffcdde989859 Uploaded
iuc
parents:
diff changeset
54
ffcdde989859 Uploaded
iuc
parents:
diff changeset
55 .. class:: warningmark
ffcdde989859 Uploaded
iuc
parents:
diff changeset
56
ffcdde989859 Uploaded
iuc
parents:
diff changeset
57 **Note**
ffcdde989859 Uploaded
iuc
parents:
diff changeset
58
ffcdde989859 Uploaded
iuc
parents:
diff changeset
59 - This tool currently treats all predictor variables as continuous numeric variables and response variable as categorical variable. Currently, the response variable can have only two classes, namely 0 and 1. The program will take 0 as base class.
ffcdde989859 Uploaded
iuc
parents:
diff changeset
60
ffcdde989859 Uploaded
iuc
parents:
diff changeset
61 - Rows containing non-numeric (or missing) data in any of the chosen columns will be skipped from the analysis.
ffcdde989859 Uploaded
iuc
parents:
diff changeset
62
ffcdde989859 Uploaded
iuc
parents:
diff changeset
63 - The summary statistics in the output are described below:
ffcdde989859 Uploaded
iuc
parents:
diff changeset
64
ffcdde989859 Uploaded
iuc
parents:
diff changeset
65 - Pseudo R-squared: the proportion of model improvement from null model
ffcdde989859 Uploaded
iuc
parents:
diff changeset
66 - p-value: p-value for the z-test of the null hypothesis that the corresponding slope is equal to zero against the two-sided alternative.
ffcdde989859 Uploaded
iuc
parents:
diff changeset
67 - Coefficient indicates log ratio of (probability to be class 1 / probability to be class 0)
ffcdde989859 Uploaded
iuc
parents:
diff changeset
68
ffcdde989859 Uploaded
iuc
parents:
diff changeset
69 - This tool also provides **Variance Inflation Factor or VIF** which quantifies the level of multicollinearity. The tool will automatic generate VIF if the model has more than one predictor. The higher the VIF, the higher is the multicollinearity. Multicollinearity will inflate standard error and reduce level of significance of the predictor. In the worst case, it can reverse direction of slope for highly correlated predictors if one of them is significant. A general thumb-rule is to use those predictors having VIF lower than 10 or 5.
ffcdde989859 Uploaded
iuc
parents:
diff changeset
70 - **vif** is calculated by
ffcdde989859 Uploaded
iuc
parents:
diff changeset
71 - First, regressing each predictor over all other predictors, and recording R-squared for each regression.
ffcdde989859 Uploaded
iuc
parents:
diff changeset
72 - Second, computing vif as 1/(1- R_squared)
ffcdde989859 Uploaded
iuc
parents:
diff changeset
73
ffcdde989859 Uploaded
iuc
parents:
diff changeset
74 </help>
ffcdde989859 Uploaded
iuc
parents:
diff changeset
75 </tool>