annotate cluster.tools/determine.IPL.threshold.xml @ 0:0decf3fd54bc draft

Uploaded
author peter-waltman
date Thu, 28 Feb 2013 01:45:39 -0500
parents
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="determine_ipl_threshold" name="Determine IPL Threshold for Consensus Clustering" force_history_refresh="True">
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
2 <command interpreter="python">determine.IPL.threshold.py
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
3 -d ${data_fname}
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
4 -f ${filter_type}
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
5 -p ${percentage_pass}
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
6 -s ${selection_criteria}
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
7 -h $report
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
8 -r ${report.files_path}
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
9 -o ${output_rdata}
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
10 </command>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
11 <inputs>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
12 <param name="data_fname" type="data" format="tabular" label="Paradigm Results File (contains both reals and nulls)"/>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
13 <param name="filter_type" type="select" label="Activity Filter" help="Specify the filter type to use (see help below)">
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
14 <option value="active">Active</option>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
15 <option value="inactive">Inactive</option>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
16 <option value="modulated" selected='true' >Modulated</option>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
17 </param>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
18 <param name="percentage_pass" type="float" label="% of Samples Passing (value in 0-1 range; >= 1 to indicate exact number of samples)" value="0.33" help="Specify the percentage of samples thatmust pass the threshold (see help below)"/>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
19 <param name="selection_criteria" type="select" label="Selection Criteria" help="Specify the test statistic to use to select the threshold (see help below)">
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
20 <option value="binomial">Binomial P-value</option>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
21 <option value="chisq">Chi-Squared P-value</option>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
22 <option value="max_diffs" selected='true' >Overall Max Number of Differences</option>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
23 </param>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
24 </inputs>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
25 <outputs>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
26 <data format="html" name="report" label="Determine IPL Threshold (HTML)"/>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
27 <data format="rdata" name="output_rdata" label="Determine IPL Threshold (RData)"/>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
28 </outputs>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
29 <help>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
30
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
31 .. class:: infomark
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
32
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
33 **Determines a statistically sound threshold to use for a given IPL result**
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
34
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
35 **Parameters**
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
36 - **Paradigm Results File** Output from Paradigm (tab-delimited and contains both the 'real' and 'null' samples)
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
37
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
38 - **Activity Filter** Specify the filter type to use. Choice of:
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
39
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
40 * Activity - Features must exceed the user-specified threshold
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
41 * Inactivity - Features must fall below the user-specified threshold
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
42 * Modulated - Absolute value of the features must exceed the specified threshold
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
43
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
44 - **Percentage of Samples Passing** Percent of samples with an IPL that passes the threshold. Choice of:
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
45
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
46 * Real Value in [0,1] - indicate the percentage of samples that pass the threshold
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
47 * Integer Value - indicate the exact number of samples that pass the threshold
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
48
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
49 - **Selection Criteria** Specify the test statistic to use to select the threshold. Choice of:
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
50
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
51 * Binomial P-value - Select the threshold with the largest -log p-value (calculated as a binomial)
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
52 * 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
53 * 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
54
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
55
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
56 </help>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
57 </tool>