annotate cluster.tools/ipl.feature.selection.xml @ 9:a3c03541fe6f draft default tip

Uploaded
author peter-waltman
date Mon, 11 Mar 2013 17:30:48 -0400
parents dddfeedb85af
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
1 <tool id="ipl_feature_selection" name="IPL Feature Selection" force_history_refresh="True">
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
2 <command interpreter="python">ipl.feature.selection.py
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
3 -d $dataset
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
4 ${genes_only}
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
5 -o ${output}
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
6
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
7 #if str($thresh_format.format) == 'manual':
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
8 -f ${thresh_format.filter}
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
9 -t ${thresh_format.threshold}
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
10 -p ${thresh_format.perc_pass}
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
11 #end if
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
12 #if str($thresh_format.format) == 'empirical':
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
13 -e ${empirical_fname}
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
14 #end if
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
15
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
16 </command>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
17 <inputs>
1
dddfeedb85af Uploaded
peter-waltman
parents: 0
diff changeset
18 <param name="dataset" type="data" format='tabular' label="IPL Data Set"/>
0
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
19 <param name="genes_only" type="boolean" label="Genes Only (check to set yes)" truevalue="-g" falsevalue="" checked="False" />
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
20
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
21 <conditional name="thresh_format" >
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
22 <param name="format" type='select' label="Input Format for Threshold Used" >
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
23 <option value="empirical" selected='true'>Output from the Determine Threshold Tool</option>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
24 <option value="manual">Manually Specify the Threshold</option>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
25 </param>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
26 <when value="manual" >
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
27 <param name="filter" type="select" label="Activity Filter" >
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
28 <option value="modulated" select='true' >Modulated</option>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
29 <option value="active">Active</option>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
30 <option value="inactive">Inactive</option>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
31 </param>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
32 <param name="perc_pass" type="float" label="% of Samples Passing (value in 0-1 range; >= 1 to indicate exact number of samples)" value="0.33"/>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
33 <param name="threshold" type="float" label="Activity Threshold" value="0.25"/>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
34 </when>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
35 <when value="empirical" >
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
36 <param name="empirical_fname" type="data" format='rdata' label="Activity Threshold File" />
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
37 </when>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
38 </conditional>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
39 </inputs>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
40 <outputs>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
41 <data format="tabular" name="output" label="Filtered IPLs"/>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
42 </outputs>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
43 <help>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
44 .. class:: infomark
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
45
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
46 **IPL Feature Selection** - Tool to filter an IPL matrix to contain only those features that exceed a given threshold for a specified percentage of samples
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
47
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
48 **OUTPUT:** A new matrix containing only the feaures that pass the user-specified filter
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
49
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
50 ----
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
51
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
52 **Parameters**
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
53
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
54 - **Genes Only** Check to limit the new matrix to only gene features
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
55
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
56 - **Input Format for Threshold Used:** - Specify the format to specify the Threshold. Choice of:
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
57 * Output from the 'Determine Threshold Tool'
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
58 * Manually Specify the Threshold
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
59
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
60 - **IF Output from the 'Determine Threshold Tool' IS SELECTED:**
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
61 * **Activity Threshold File** Specify the result file from the 'Determine IPL Threshold for Consensus Clustering" tool
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
62
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
63 - **IF Manually Specify the Threshold IS SELECTED:**
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
64 * **Activity Filter** Specify the filter type to use. Choice of:
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
65
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
66 * Activity - Features must exceed the user-specified threshold
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
67 * Inactivity - Features must fall below the user-specified threshold
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
68 * Modulated - Absolute value of the features must exceed the specified threshold
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
69
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
70 * **Percentage of Samples Passing** Percent of samples with an IPL that passes the threshold. Choice of:
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
71
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
72 * Real Value in [0,1] - indicate the percentage of samples that pass the threshold
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
73 * Integer Value - indicate the exact number of samples that pass the threshold
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
74
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
75 * **Selection Criteria** Specify the test statistic to use to select the threshold. Choice of:
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
76
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
77 * Binomial P-value - Select the threshold with the largest -log p-value (calculated as a binomial)
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
78 * Chi-Squared P-value - Select the threshold with the largest -log p-value (calculated as a Chi-squared)
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
79 * Overall Max Number of Differences - Select the threshold with the largest overall number of differences between the real and null distributions
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
80
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
81
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
82 </help>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
83 </tool>