annotate linear_regression.xml @ 0:cf431604ec3e draft default tip

Imported from capsule None
author devteam
date Tue, 01 Apr 2014 10:52:17 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
1 <tool id="LinearRegression1" name="Perform Linear Regression" version="1.0.1">
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
2 <description> </description>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
3 <requirements>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
4 <requirement type="package" version="2.11.0">R</requirement>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
5 <requirement type="package" version="1.7.1">numpy</requirement>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
6 <requirement type="package" version="1.0.3">rpy</requirement>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
7 </requirements>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
8 <command interpreter="python">
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
9 linear_regression.py
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
10 $input1
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
11 $response_col
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
12 $predictor_cols
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
13 $out_file1
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
14 $out_file2
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
15 1>/dev/null
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
16 </command>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
17 <inputs>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
18 <param format="tabular" name="input1" type="data" label="Select data" help="Dataset missing? See TIP below."/>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
19 <param name="response_col" label="Response column (Y)" type="data_column" data_ref="input1" numerical="True"/>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
20 <param name="predictor_cols" label="Predictor columns (X)" type="data_column" data_ref="input1" numerical="True" multiple="true" >
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
21 <validator type="no_options" message="Please select at least one column."/>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
22 </param>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
23 </inputs>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
24 <outputs>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
25 <data format="input" name="out_file1" metadata_source="input1" />
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
26 <data format="pdf" name="out_file2" />
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
27 </outputs>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
28 <requirements>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
29 <requirement type="python-module">rpy</requirement>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
30 </requirements>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
31 <tests>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
32 <test>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
33 <param name="input1" value="regr_inp.tabular"/>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
34 <param name="response_col" value="3"/>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
35 <param name="predictor_cols" value="1,2"/>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
36 <output name="out_file1" file="regr_out.tabular"/>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
37 <output name="out_file2" file="regr_out.pdf"/>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
38 </test>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
39 </tests>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
40 <help>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
41
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
42
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
43 .. class:: infomark
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
44
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
45 **TIP:** If your data is not TAB delimited, use *Edit Datasets-&gt;Convert characters*
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
46
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
47 -----
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
48
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
49 .. class:: infomark
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
50
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
51 **What it does**
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
52
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
53 This tool uses the 'lm' function from R statistical package to perform linear regression on the input data. It outputs two files, one containing the summary statistics of the performed regression, and the other containing diagnostic plots to check whether model assumptions are satisfied.
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
54
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
55 *R Development Core Team (2009). 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.*
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
56
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
57 -----
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
58
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
59 .. class:: warningmark
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
60
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
61 **Note**
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
62
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
63 - This tool currently treats all predictor and response variables as continuous numeric variables. Running the tool on categorical variables might result in incorrect results.
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
64
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
65 - Rows containing non-numeric (or missing) data in any of the chosen columns will be skipped from the analysis.
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
66
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
67 - The summary statistics in the output are described below:
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
68
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
69 - sigma: the square root of the estimated variance of the random error (standard error of the residiuals)
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
70 - R-squared: the fraction of variance explained by the model
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
71 - Adjusted R-squared: the above R-squared statistic adjusted, penalizing for the number of the predictors (p)
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
72 - p-value: p-value for the t-test of the null hypothesis that the corresponding slope is equal to zero against the two-sided alternative.
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
73
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
74
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
75 </help>
cf431604ec3e Imported from capsule None
devteam
parents:
diff changeset
76 </tool>