annotate plotwithscale.xml @ 91:2a83c5aafade draft

Uploaded 20180221
author fabio
date Wed, 21 Feb 2018 13:33:17 -0500
parents f81d72e482cf
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
83
f81d72e482cf Uploaded
fabio
parents:
diff changeset
1 <tool id="iwtomics_plotwithscale" name="IWTomics Plot with Threshold" version="@VERSION@.0">
f81d72e482cf Uploaded
fabio
parents:
diff changeset
2 <description>on Test Scale</description>
f81d72e482cf Uploaded
fabio
parents:
diff changeset
3 <macros>
f81d72e482cf Uploaded
fabio
parents:
diff changeset
4 <import>macros.xml</import>
f81d72e482cf Uploaded
fabio
parents:
diff changeset
5 </macros>
f81d72e482cf Uploaded
fabio
parents:
diff changeset
6 <expand macro="requirements" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
7
f81d72e482cf Uploaded
fabio
parents:
diff changeset
8 <command detect_errors="exit_code">
f81d72e482cf Uploaded
fabio
parents:
diff changeset
9 <![CDATA[
f81d72e482cf Uploaded
fabio
parents:
diff changeset
10 Rscript '$__tool_directory__/plotwithscale.R' adjustedpvalue='${adjustedpvalue}' iwtomicsrespdf='${iwtomicsrespdf}' iwtomicssumpdf='${iwtomicssumpdf}'
f81d72e482cf Uploaded
fabio
parents:
diff changeset
11 iwtomicsrdata='${rdata}'
f81d72e482cf Uploaded
fabio
parents:
diff changeset
12 iwtomicstests='${testids}'
f81d72e482cf Uploaded
fabio
parents:
diff changeset
13 iwtomicsselectedfeatures='${featureids}'
f81d72e482cf Uploaded
fabio
parents:
diff changeset
14
f81d72e482cf Uploaded
fabio
parents:
diff changeset
15 #set test_subset = '|'.join( [ str( $e.test ) for $e in $scalesection.thresholdontestscale ] )
f81d72e482cf Uploaded
fabio
parents:
diff changeset
16 test_subset='${test_subset}'
f81d72e482cf Uploaded
fabio
parents:
diff changeset
17 #set feature_subset = '|'.join( [ str( $e.feature ) for $e in $scalesection.thresholdontestscale ] )
f81d72e482cf Uploaded
fabio
parents:
diff changeset
18 feature_subset='${feature_subset}'
f81d72e482cf Uploaded
fabio
parents:
diff changeset
19 #set scale_subset = ','.join( [ str( $e.scale ) for $e in $scalesection.thresholdontestscale ] )
f81d72e482cf Uploaded
fabio
parents:
diff changeset
20 scale_subset='c(${scale_subset})'
f81d72e482cf Uploaded
fabio
parents:
diff changeset
21
f81d72e482cf Uploaded
fabio
parents:
diff changeset
22 testalpha='${plotres.alpha}'
f81d72e482cf Uploaded
fabio
parents:
diff changeset
23 average='${plotres.average}'
f81d72e482cf Uploaded
fabio
parents:
diff changeset
24 size='${plotres.size}'
f81d72e482cf Uploaded
fabio
parents:
diff changeset
25 plottype="'${plotres.conditionalplottype.plottype}'"
f81d72e482cf Uploaded
fabio
parents:
diff changeset
26 #if $plotres.conditionalplottype.plottype == 'boxplot':
f81d72e482cf Uploaded
fabio
parents:
diff changeset
27 #set probs = ','.join( [ str( $p.prob ) for $p in $plotres.conditionalplottype.probabilitiessection.probabilities ] )
f81d72e482cf Uploaded
fabio
parents:
diff changeset
28 #if $probs != "":
f81d72e482cf Uploaded
fabio
parents:
diff changeset
29 probs='c(${plotres.conditionalplottype.probabilitiessection.prob0},${plotres.conditionalplottype.probabilitiessection.prob1},${plotres.conditionalplottype.probabilitiessection.prob2},${probs})'
f81d72e482cf Uploaded
fabio
parents:
diff changeset
30 #else:
f81d72e482cf Uploaded
fabio
parents:
diff changeset
31 probs='c(${plotres.conditionalplottype.probabilitiessection.prob0},${plotres.conditionalplottype.probabilitiessection.prob1},${plotres.conditionalplottype.probabilitiessection.prob2})'
f81d72e482cf Uploaded
fabio
parents:
diff changeset
32 #end if
f81d72e482cf Uploaded
fabio
parents:
diff changeset
33 #end if
f81d72e482cf Uploaded
fabio
parents:
diff changeset
34
f81d72e482cf Uploaded
fabio
parents:
diff changeset
35 groupby="'${plotsum.conditionalgroupby.groupby}'"
f81d72e482cf Uploaded
fabio
parents:
diff changeset
36 #if $plotsum.conditionalgroupby.groupby == "test":
f81d72e482cf Uploaded
fabio
parents:
diff changeset
37 summaryalpha='${plotsum.conditionalgroupby.testalphaplot}'
f81d72e482cf Uploaded
fabio
parents:
diff changeset
38 only_significant='${plotsum.conditionalgroupby.testonlysig}'
f81d72e482cf Uploaded
fabio
parents:
diff changeset
39 #elif $plotsum.conditionalgroupby.groupby == "feature":
f81d72e482cf Uploaded
fabio
parents:
diff changeset
40 summaryalpha='${plotsum.conditionalgroupby.featurealphaplot}'
f81d72e482cf Uploaded
fabio
parents:
diff changeset
41 only_significant='${plotsum.conditionalgroupby.featureonlysig}'
f81d72e482cf Uploaded
fabio
parents:
diff changeset
42 #end if
f81d72e482cf Uploaded
fabio
parents:
diff changeset
43 ]]>
f81d72e482cf Uploaded
fabio
parents:
diff changeset
44 </command>
f81d72e482cf Uploaded
fabio
parents:
diff changeset
45
f81d72e482cf Uploaded
fabio
parents:
diff changeset
46 <inputs>
f81d72e482cf Uploaded
fabio
parents:
diff changeset
47 <!-- RData -->
f81d72e482cf Uploaded
fabio
parents:
diff changeset
48 <param format="rdata" name="rdata" type="data" label="Select IWTomicsData object with test results" help="File created by 'IWTomics Test and Plot'." />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
49 <!-- test IDs -->
f81d72e482cf Uploaded
fabio
parents:
diff changeset
50 <param format="tabular" name="testids" type="data" label="Select test IDs" help="File created by 'IWTomics Test and Plot'." />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
51 <!-- feature IDs -->
f81d72e482cf Uploaded
fabio
parents:
diff changeset
52 <param format="tabular" name="featureids" type="data" label="Select feature IDs" help="File created by 'IWTomics Test and Plot'." />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
53
f81d72e482cf Uploaded
fabio
parents:
diff changeset
54 <!-- repeat threshold on test scale -->
f81d72e482cf Uploaded
fabio
parents:
diff changeset
55 <section name="scalesection" title="Select scale for Interval-Wise Testing and plot" expanded="True" help="Maximum interval length for the p-value adjustment. If 0 the maximum possible scale is used.">
f81d72e482cf Uploaded
fabio
parents:
diff changeset
56 <repeat name="thresholdontestscale" title="Threshold on test scale" min="1">
f81d72e482cf Uploaded
fabio
parents:
diff changeset
57 <param name="test" type="data_column" data_ref="testids" numerical="False" label="Test ID" multiple="True" use_header_names="True" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
58 <param name="feature" type="data_column" data_ref="featureids" numerical="False" label="Feature ID" multiple="True" use_header_names="True" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
59 <param name="scale" type="integer" value="0" min="0" label="Scale" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
60 </repeat>
f81d72e482cf Uploaded
fabio
parents:
diff changeset
61 </section>
f81d72e482cf Uploaded
fabio
parents:
diff changeset
62
f81d72e482cf Uploaded
fabio
parents:
diff changeset
63 <!-- plot IWTomics results -->
f81d72e482cf Uploaded
fabio
parents:
diff changeset
64 <section name="plotres" title="Plot IWTomics test results" expanded="True">
f81d72e482cf Uploaded
fabio
parents:
diff changeset
65 <!-- alpha -->
f81d72e482cf Uploaded
fabio
parents:
diff changeset
66 <param name="alpha" size="3" type="float" value="0.05" min="0.0" max="1.0" label="Level of the test (alpha)" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
67 <expand macro="plot-params" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
68 </section>
f81d72e482cf Uploaded
fabio
parents:
diff changeset
69
f81d72e482cf Uploaded
fabio
parents:
diff changeset
70 <!-- summary plot -->
f81d72e482cf Uploaded
fabio
parents:
diff changeset
71 <expand macro="plot-sum" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
72 </inputs>
f81d72e482cf Uploaded
fabio
parents:
diff changeset
73
f81d72e482cf Uploaded
fabio
parents:
diff changeset
74 <outputs>
f81d72e482cf Uploaded
fabio
parents:
diff changeset
75 <data format="txt" name="adjustedpvalue" label="${tool.name} on ${on_string}: Adjusted p-value" from_work_dir="iwtomics.plotwithscale.adjustedpvalue.txt" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
76 <data format="pdf" name="iwtomicsrespdf" label="${tool.name} on ${on_string}: Plotted Test Results" from_work_dir="iwtomics.plotwithscale.iwtomicstestresults.pdf" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
77 <data format="pdf" name="iwtomicssumpdf" label="${tool.name} on ${on_string}: Summary Plot" from_work_dir="iwtomics.plotwithscale.summaryplot.pdf" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
78 </outputs>
f81d72e482cf Uploaded
fabio
parents:
diff changeset
79
f81d72e482cf Uploaded
fabio
parents:
diff changeset
80 <tests>
f81d72e482cf Uploaded
fabio
parents:
diff changeset
81 <test>
f81d72e482cf Uploaded
fabio
parents:
diff changeset
82 <param name="rdata" value="output_testandplot/iwtomics.testandplot.RData" ftype="rdata" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
83 <param name="testids" value="output_testandplot/iwtomics.testandplot.tests.txt" ftype="tabular" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
84 <param name="featureids" value="output_testandplot/iwtomics.testandplot.selectedfeatures.txt" ftype="tabular" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
85 <repeat name="thresholdontestscale">
f81d72e482cf Uploaded
fabio
parents:
diff changeset
86 <param name="test" value="1" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
87 <param name="feature" value="1" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
88 <param name="scale" value="10" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
89 </repeat>
f81d72e482cf Uploaded
fabio
parents:
diff changeset
90 <repeat name="thresholdontestscale">
f81d72e482cf Uploaded
fabio
parents:
diff changeset
91 <param name="test" value="1,2,3" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
92 <param name="feature" value="2" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
93 <param name="scale" value="20" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
94 </repeat>
f81d72e482cf Uploaded
fabio
parents:
diff changeset
95 <param name="alpha" value="0.05" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
96 <param name="average" value="TRUE" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
97 <param name="size" value="TRUE" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
98 <param name="plottype" value="boxplot" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
99 <param name="prob0" value="0.25" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
100 <param name="prob1" value="0.5" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
101 <param name="prob2" value="0.75" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
102 <param name="groupby" value="feature" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
103 <param name="featurealphaplot" value="0.05" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
104 <param name="featureonlysig" value="TRUE" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
105 <output name="adjustedpvalue" file="output_plotwithscale/iwtomics.plotwithscale.adjustedpvalue.txt" compare="sim_size" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
106 <output name="iwtomicsrespdf" file="output_plotwithscale/iwtomics.plotwithscale.iwtomicstestresults.pdf" compare="sim_size" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
107 <output name="iwtomicssumpdf" file="output_plotwithscale/iwtomics.plotwithscale.summaryplot.pdf" compare="sim_size" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
108 </test>
f81d72e482cf Uploaded
fabio
parents:
diff changeset
109 </tests>
f81d72e482cf Uploaded
fabio
parents:
diff changeset
110
f81d72e482cf Uploaded
fabio
parents:
diff changeset
111 <help><![CDATA[
f81d72e482cf Uploaded
fabio
parents:
diff changeset
112 This tool allows to select the scale for the Interval-Wise Testing results. In particular, it returns the p-value curves
f81d72e482cf Uploaded
fabio
parents:
diff changeset
113 for the different tests performed at the selected scale, and it creates a graphical representation of the
f81d72e482cf Uploaded
fabio
parents:
diff changeset
114 Interval-Wise Testing results and a summary plot (optional) at the selected scale.
f81d72e482cf Uploaded
fabio
parents:
diff changeset
115
f81d72e482cf Uploaded
fabio
parents:
diff changeset
116 -----
f81d72e482cf Uploaded
fabio
parents:
diff changeset
117
f81d72e482cf Uploaded
fabio
parents:
diff changeset
118 **Input files**
f81d72e482cf Uploaded
fabio
parents:
diff changeset
119
f81d72e482cf Uploaded
fabio
parents:
diff changeset
120 RData file with the IWTomicsData object with test results, tabular files with test IDs and feature IDs.
f81d72e482cf Uploaded
fabio
parents:
diff changeset
121 These files are created by the tool *IWTomics Test and Plot*.
f81d72e482cf Uploaded
fabio
parents:
diff changeset
122
f81d72e482cf Uploaded
fabio
parents:
diff changeset
123 -----
f81d72e482cf Uploaded
fabio
parents:
diff changeset
124
f81d72e482cf Uploaded
fabio
parents:
diff changeset
125 **Output**
f81d72e482cf Uploaded
fabio
parents:
diff changeset
126
f81d72e482cf Uploaded
fabio
parents:
diff changeset
127 The tool returns:
f81d72e482cf Uploaded
fabio
parents:
diff changeset
128
f81d72e482cf Uploaded
fabio
parents:
diff changeset
129 1. TXT file with an adjusted p-value curve for every test performed at the selected scale;
f81d72e482cf Uploaded
fabio
parents:
diff changeset
130 2. PDF file with the plotted test results;
f81d72e482cf Uploaded
fabio
parents:
diff changeset
131 3. PDF file with the summary plot.
f81d72e482cf Uploaded
fabio
parents:
diff changeset
132
f81d72e482cf Uploaded
fabio
parents:
diff changeset
133 -----
f81d72e482cf Uploaded
fabio
parents:
diff changeset
134
f81d72e482cf Uploaded
fabio
parents:
diff changeset
135 .. class:: infomark
f81d72e482cf Uploaded
fabio
parents:
diff changeset
136
f81d72e482cf Uploaded
fabio
parents:
diff changeset
137 **Notes**
f81d72e482cf Uploaded
fabio
parents:
diff changeset
138
f81d72e482cf Uploaded
fabio
parents:
diff changeset
139 This Galaxy tool has been developed by Fabio Cumbo (Third University of Rome, Italy) and Marzia A. Cremona (The Pennsylvania State University, USA).
f81d72e482cf Uploaded
fabio
parents:
diff changeset
140
f81d72e482cf Uploaded
fabio
parents:
diff changeset
141 It implements a simplified version of the function *IWTomicsTest*, *plotTest* and *plotSummary* for *IWTomicsData* objects.
f81d72e482cf Uploaded
fabio
parents:
diff changeset
142 The complete version can be found in the *R/Bioconductor* package *IWTomics* (see vignette_).
f81d72e482cf Uploaded
fabio
parents:
diff changeset
143
f81d72e482cf Uploaded
fabio
parents:
diff changeset
144 .. _vignette: https://bioconductor.org/packages/release/bioc/vignettes/IWTomics/inst/doc/IWTomics.pdf
f81d72e482cf Uploaded
fabio
parents:
diff changeset
145 ]]></help>
f81d72e482cf Uploaded
fabio
parents:
diff changeset
146
f81d72e482cf Uploaded
fabio
parents:
diff changeset
147 <expand macro="citations" />
f81d72e482cf Uploaded
fabio
parents:
diff changeset
148
f81d72e482cf Uploaded
fabio
parents:
diff changeset
149 </tool>