annotate abims_sartools_edger.xml @ 3:de6d0b7c17af draft

release 1.6.3
author lgueguen
date Mon, 01 Oct 2018 05:07:56 -0400
parents d86ccac2a660
children 05c9b1a7f44e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
d86ccac2a660 New release of SARTools (1.3.2)
lgueguen
parents: 0
diff changeset
1 <tool id="sartools_edger" name="SARTools edgeR" version="@WRAPPER_VERSION@.0">
0
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
2
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
3 <!-- [REQUIRED] Tool description displayed after the tool name -->
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
4 <description>Compare two or more biological conditions in a RNA-Seq framework with edgeR</description>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
5
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
6 <macros>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
7 <import>macros.xml</import>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
8 </macros>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
9
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
10 <expand macro="requirements"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
11 <expand macro="stdio"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
12
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
13
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
14 <!-- [REQUIRED] The command to execute -->
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
15 <command interpreter="python"><![CDATA[
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
16
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
17 abims_sartools_edger_wrapper.py
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
18 ## parameters
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
19 @COMMAND_BASIC_PARAMETERS@
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
20 #if str( $advanced_parameters.adv_param ) == "show":
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
21 @COMMAND_BATCH_PARAM@
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
22 --alpha $advanced_parameters.alpha
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
23 --pAdjustMethod $advanced_parameters.pAdjustMethod
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
24 --cpmCutoff $advanced_parameters.cpmCutoff
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
25 --geneSelection $advanced_parameters.geneSelection
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
26 --normalizationMethod $advanced_parameters.normalizationMethod
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
27 --colors $advanced_parameters.colors
3
de6d0b7c17af release 1.6.3
lgueguen
parents: 2
diff changeset
28 --forceCairoGraph $advanced_parameters.forceCairoGraph
0
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
29 #end if
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
30 ## ouputs
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
31 @COMMAND_OUTPUTS@
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
32
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
33 ]]></command>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
34
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
35 <!-- [REQUIRED] Input files and tool parameters -->
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
36 <inputs>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
37
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
38 <expand macro="basic_parameters" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
39
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
40 <conditional name="advanced_parameters" >
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
41 <param name="adv_param" type="select" label="Advanced Parameters" help="" >
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
42 <option value="hide" selected="true">Hide</option>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
43 <option value="show">Show</option>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
44 </param>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
45 <when value="hide" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
46 <when value="show">
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
47 <expand macro="batch_param" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
48 <expand macro="alpha_param" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
49 <expand macro="padjustmethod_param" />
3
de6d0b7c17af release 1.6.3
lgueguen
parents: 2
diff changeset
50 <param type="integer" value="1" min="0" label="Counts-per-million cut-off to filter low counts" argument="--cpmCutoff" help="Set to 0 to disable filtering. Default is 1." />
de6d0b7c17af release 1.6.3
lgueguen
parents: 2
diff changeset
51 <param name="geneSelection" type="select" label="Selection of the features in MDSPlot" argument="--gene.selection" help="Default is 'pairwise'." >
0
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
52 <option value="pairwise" selected="true">pairwise</option>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
53 <option value="common">common</option>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
54 </param>
3
de6d0b7c17af release 1.6.3
lgueguen
parents: 2
diff changeset
55 <param type="select" label="Normalization method in calcNormFactors" argument="--normalizationMethod" help="'TMM' (default), 'RLE' (DESeq method) or 'upperquartile'." >
0
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
56 <option value="TMM" selected="true">TMM</option>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
57 <option value="RLE">RLE</option>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
58 <option value="upperquartile">upperquartile</option>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
59 </param>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
60 <expand macro="colors_param" />
3
de6d0b7c17af release 1.6.3
lgueguen
parents: 2
diff changeset
61 <expand macro="forceCairoGraph_param" />
0
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
62 </when>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
63 </conditional>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
64
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
65 </inputs>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
66
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
67 <!-- [REQUIRED] Output files -->
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
68 <outputs>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
69
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
70 <expand macro="outputs" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
71
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
72 </outputs>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
73
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
74 <!-- [OPTIONAL] Tests to be run manually by the Galaxy admin -->
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
75 <tests>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
76 <!-- [HELP] Test files have to be in the ~/test-data directory -->
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
77 <test>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
78 <!-- Test with 2 conditions, 2 replicates, 10 features -->
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
79 <param name="targetFile" dbkey="?" value="target_small.txt" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
80 <param name="rawDir" value="raw_small.zip" dbkey="?" ftype="zip"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
81 <param name="adv_param" value="show"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
82 <output name="log">
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
83 <assert_contents>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
84 <has_text text="KO vs WT 5 4 9" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
85 <has_text text="HTML report created" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
86 </assert_contents>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
87 </output>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
88 </test>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
89 <!-- <test>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
90 --> <!-- NOT WORKING YET: Test with 3 conditions, 3 replicates, 10 features, with batch effect -->
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
91 <!-- <param name="targetFile" dbkey="?" value="targetT048_small.txt" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
92 <param name="rawDir" value="rawT048_small.zip" dbkey="?" ftype="no_unzip.zip"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
93 <param name="condRef" value="T0"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
94 <param name="adv_param" value="show"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
95 <param name="condition" value="true"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
96 <output name="tables_html" file="SARTools_edgeR_targetT048_small_tables.html" lines_diff="12">
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
97 <extra_files type="file" name="T4vsT0.complete.txt" value="SARTools_edgeR_T4vsT0_small.complete.txt"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
98 <extra_files type="file" name="T8vsT0.complete.txt" value="SARTools_edgeR_T8vsT0_small.complete.txt"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
99 <extra_files type="file" name="T8vsT4.complete.txt" value="SARTools_edgeR_T8vsT4_small.complete.txt"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
100 </output>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
101 </test>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
102 --> <test>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
103 <!-- Test with 2 conditions, 2 replicates, 8217 features -->
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
104 <param name="targetFile" dbkey="?" value="target.txt" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
105 <param name="rawDir" value="raw.zip" dbkey="?" ftype="zip"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
106 <param name="adv_param" value="show"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
107 <output name="log">
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
108 <assert_contents>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
109 <has_text text="KO vs WT 2691 2713 5404" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
110 <has_text text="HTML report created" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
111 </assert_contents>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
112 </output>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
113 </test>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
114 <!-- <test>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
115 --> <!-- NOT WORKING YET: Test with 3 conditions, 3 replicates, 10160 features, with batch effect -->
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
116 <!-- <param name="targetFile" dbkey="?" value="targetT048.txt" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
117 <param name="rawDir" value="rawT048.zip" dbkey="?" ftype="no_unzip.zip"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
118 <param name="condRef" value="T0"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
119 <param name="adv_param" value="show"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
120 <param name="condition" value="true"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
121 <output name="tables_html" file="SARTools_edgeR_targetT048_tables.html" lines_diff="14">
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
122 <extra_files type="file" name="T4vsT0.complete.txt" value="SARTools_edgeR_T4vsT0.complete.txt"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
123 <extra_files type="file" name="T8vsT0.complete.txt" value="SARTools_edgeR_T8vsT0.complete.txt"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
124 <extra_files type="file" name="T8vsT4.complete.txt" value="SARTools_edgeR_T8vsT4.complete.txt"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
125 </output>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
126 </test>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
127 --> </tests>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
128
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
129 <!-- [OPTIONAL] Help displayed in Galaxy -->
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
130 <help><![CDATA[
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
131
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
132 @HELP_AUTHORS@
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
133
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
134 ==============
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
135 SARTools edgeR
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
136 ==============
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
137
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
138 -----------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
139 Description
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
140 -----------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
141
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
142 @HELP_DESCRIPTION@
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
143
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
144
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
145 -----------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
146 Input files
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
147 -----------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
148
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
149 @HELP_INPUT_FILES@
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
150
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
151
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
152 ----------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
153 Parameters
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
154 ----------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
155
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
156 @HELP_BASIC_PARAMETERS@
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
157 * **batch:** adjustment variable to use as a batch effect, must be a column of the target file (NULL if no batch effect needs to be taken into account);
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
158 * **alpha:** significance threshold applied to the adjusted p-values to select the differentially expressed features (default is 0.05);
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
159 * **pAdjustMethod:** p-value adjustment method for multiple testing [4, 5] ("BH" by default, "BY" or any value of p.adjust.methods);
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
160 * **cpmCutoff:** counts-per-million cut-off to filter low counts (default is 1, set to 0 to disable filtering);
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
161 * **gene.selection:** method of selection of the features for the MultiDimensional Scaling plot ("pairwise" by default or common);
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
162 * **normalizationMethod:** normalization method in calcNormFactors(): "TMM" (default), "RLE" (DESeq method) or "upperquartile";
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
163 * **colors:** colors used for the figures (one per biological condition), 8 are given by default.
3
de6d0b7c17af release 1.6.3
lgueguen
parents: 2
diff changeset
164 * **forceCairoGraph:** TRUE or FALSE (default) to force the use of cairo with options(bitmapType="cairo").
0
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
165
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
166
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
167 ------------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
168 Output files
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
169 ------------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
170
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
171 @HELP_OUTPUT_FILES@
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
172
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
173
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
174 ---------------------------------------------------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
175
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
176 [1] G.-K. Smyth. Limma: linear models for microarray data. In R. Gentleman, V. Carey, S. Dudoit, R. Irizarry, and W. Huber, editors, Bioinformatics and Computational Biology Solutions Using R and Bioconductor, pages 397–420. Springer, New York, 2005.
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
177
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
178 [2] S. Anders. HTSeq: Analysing high-throughput sequencing data with Python. http://www-huber.embl.de/users/anders/HTSeq/, 2011.
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
179
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
180 [3] S. Anders, P.-T. Pyl, and W. Huber. HTSeq - A Python framework to work with high-throughput sequencing data. bioRxiv preprint, 2014. URL: http://dx.doi.org/10.1101/002824.
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
181
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
182 [4] Y. Benjamini and Y. Hochberg. Controlling the false discovery rate: a practical and powerful approach to multiple testing. Journal of the Royal Statistical Society B, 57:289–300, 1995.
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
183
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
184 [5] Y. Benjamini and D. Yekutieli. The control of the false discovery rate in multiple testing under dependency. Ann. Statist., 29(4):1165–1188, 2001.
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
185
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
186
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
187 ]]></help>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
188
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
189 <citations>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
190 <expand macro="common_citations" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
191 </citations>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
192
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
193 </tool>