annotate abims_sartools_deseq2.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_deseq2" name="SARTools DESeq2" 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 DESeq2</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 <!-- [REQUIRED] The command to execute -->
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
14 <command interpreter="python"><![CDATA[
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
15
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
16 abims_sartools_deseq2_wrapper.py
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
17 ## parameters
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
18 @COMMAND_BASIC_PARAMETERS@
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
19 #if str( $advanced_parameters.adv_param ) == "show":
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
20 @COMMAND_BATCH_PARAM@
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
21 --fitType $advanced_parameters.fitType
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
22 --cooksCutoff $advanced_parameters.cooksCutoff
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
23 --independentFiltering $advanced_parameters.independentFiltering
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
24 --alpha $advanced_parameters.alpha
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
25 --pAdjustMethod $advanced_parameters.pAdjustMethod
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
26 --typeTrans $advanced_parameters.typeTrans
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
27 --locfunc $advanced_parameters.locfunc
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
28 --colors $advanced_parameters.colors
3
de6d0b7c17af release 1.6.3
lgueguen
parents: 2
diff changeset
29 --forceCairoGraph $advanced_parameters.forceCairoGraph
0
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
30 #end if
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
31 ## ouputs
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
32 @COMMAND_OUTPUTS@
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
33
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
34 ]]></command>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
35
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
36 <!-- [REQUIRED] Input files and tool parameters -->
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
37 <inputs>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
38
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
39 <expand macro="basic_parameters" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
40
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
41 <conditional name="advanced_parameters" >
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
42 <param name="adv_param" type="select" label="Advanced Parameters" help="" >
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
43 <option value="hide" selected="true">Hide</option>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
44 <option value="show">Show</option>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
45 </param>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
46 <when value="hide" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
47 <when value="show">
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
48 <expand macro="batch_param" />
3
de6d0b7c17af release 1.6.3
lgueguen
parents: 2
diff changeset
49 <param type="select" label="Mean-variance relationship" argument="--fitType" help="Type of model for the mean-dispersion relationship. Parametric by default." >
0
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
50 <option value="parametric" selected="true">parametric</option>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
51 <option value="local">local</option>
3
de6d0b7c17af release 1.6.3
lgueguen
parents: 2
diff changeset
52 <option value="mean">mean</option>
0
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
53 </param>
3
de6d0b7c17af release 1.6.3
lgueguen
parents: 2
diff changeset
54 <param type="boolean" checked="true" truevalue="TRUE" falsevalue="FALSE" label="Perform the outliers detection" argument="--cooksCutoff" help="Checked by default."/>
de6d0b7c17af release 1.6.3
lgueguen
parents: 2
diff changeset
55 <param type="boolean" checked="true" truevalue="TRUE" falsevalue="FALSE" label="Perform independent filtering" argument="--independentFiltering" help="Checked by default."/>
0
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
56 <expand macro="alpha_param" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
57 <expand macro="padjustmethod_param" />
3
de6d0b7c17af release 1.6.3
lgueguen
parents: 2
diff changeset
58 <param type="select" label="Transformation for PCA/clustering" argument="--typeTrans" help="Method of transformation of the counts for the clustering and the PCA: 'VST' (default) for Variance Stabilizing Transformation, or 'rlog' for Regularized Log Transformation." >
0
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
59 <option value="VST" selected="true">VST</option>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
60 <option value="rlog">rlog</option>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
61 </param>
3
de6d0b7c17af release 1.6.3
lgueguen
parents: 2
diff changeset
62 <param type="select" label="Estimation of the size factors" argument="--locfunc" help="'median' (default) or 'shorth' from the genefilter package." >
0
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
63 <option value="median" selected="true">median</option>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
64 <option value="shorth">shorth</option>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
65 </param>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
66 <expand macro="colors_param" />
3
de6d0b7c17af release 1.6.3
lgueguen
parents: 2
diff changeset
67 <expand macro="forceCairoGraph_param" />
0
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
68 </when>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
69 </conditional>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
70
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
71 </inputs>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
72
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
73 <!-- [REQUIRED] Output files -->
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
74 <outputs>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
75
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
76 <expand macro="outputs" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
77
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
78 </outputs>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
79
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
80 <!-- [OPTIONAL] Tests to be run manually by the Galaxy admin -->
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
81 <tests>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
82 <!-- [HELP] Test files have to be in the ~/test-data directory -->
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
83 <test>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
84 <!-- Test with 2 conditions, 2 replicates, 8217 features -->
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
85 <param name="targetFile" dbkey="?" value="target.txt" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
86 <param name="rawDir" value="raw.zip" dbkey="?" ftype="zip"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
87 <param name="adv_param" value="show"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
88 <output name="log">
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
89 <assert_contents>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
90 <has_text text="KO vs WT 0.1 171" />
3
de6d0b7c17af release 1.6.3
lgueguen
parents: 2
diff changeset
91 <has_text text="KO vs WT 2583 2663 5246" />
0
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
92 <has_text text="HTML report created" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
93 </assert_contents>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
94 </output>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
95 </test>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
96 <!-- <test>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
97 --> <!-- NOT WORKING YET: Test with 3 conditions, 3 replicates, 10160 features, with batch effect -->
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
98 <!-- <param name="targetFile" dbkey="?" value="targetT048.txt" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
99 <param name="rawDir" value="rawT048.zip" dbkey="?" ftype="no_unzip.zip"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
100 <param name="condRef" value="T0"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
101 <param name="adv_param" value="show"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
102 <param name="condition" value="true"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
103 <output name="tables_html" file="SARTools_DESeq2_targetT048_tables.html" lines_diff="14">
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
104 <extra_files type="file" name="T4vsT0.complete.txt" value="SARTools_DESeq2_T4vsT0.complete.txt"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
105 <extra_files type="file" name="T8vsT0.complete.txt" value="SARTools_DESeq2_T8vsT0.complete.txt"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
106 <extra_files type="file" name="T8vsT4.complete.txt" value="SARTools_DESeq2_T8vsT4.complete.txt"/>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
107 </output>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
108 </test>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
109 --> </tests>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
110
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
111 <!-- [OPTIONAL] Help displayed in Galaxy -->
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
112 <help><![CDATA[
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
113
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
114 @HELP_AUTHORS@
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
115
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
116 ===============
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
117 SARTools DESeq2
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
118 ===============
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
119
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
120 -----------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
121 Description
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
122 -----------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
123
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
124 @HELP_DESCRIPTION@
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
125
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
126
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
127 -----------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
128 Input files
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
129 -----------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
130
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
131 @HELP_INPUT_FILES@
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
132
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
133
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
134 ----------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
135 Parameters
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
136 ----------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
137
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
138 @HELP_BASIC_PARAMETERS@
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
139 * **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
140 * **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
141 * **fitType:** type of model for the mean-dispersion relationship ("parametric" by default, or "local");
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
142 * **cooksCutoff:** TRUE (default) of FALSE to execute or not the detection of the outliers [4];
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
143 * **independentFiltering:** TRUE (default) of FALSE to execute or not the independent filtering [5];
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
144 * **pAdjustMethod:** p-value adjustment method for multiple testing [6, 7] ("BH" by default, "BY" or any value of p.adjust.methods);
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
145 * **typeTrans:** method of transformation of the counts for the clustering and the PCA (default is "VST" for Variance Stabilizing Transformation, or "rlog" for Regularized Log Transformation);
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
146 * **locfunc:** function used for the estimation of the size factors (default is "median", or "shorth" from the genefilter package);
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
147 * **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
148 * **forceCairoGraph:** TRUE or FALSE (default) to force the use of cairo with options(bitmapType="cairo").
0
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
149
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
150
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
151 ------------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
152 Output files
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
153 ------------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
154
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
155 @HELP_OUTPUT_FILES@
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
156
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
157
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
158 ---------------------------------------------------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
159
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
160 [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
161
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
162 [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
163
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
164 [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
165
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
166 [4] R.-D. Cook. Detection of Influential Observation in Linear Regression. Technometrics, February 1977.
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
167
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
168 [5] R. Bourgon, R. Gentleman, and W. Huber. Independent filtering increases detection power for high-throughput experiments. PNAS, 107(21):9546–9551, 2010. URL: http://www.pnas.org/content/107/21/9546.long.
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
169
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
170 [6] 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
171
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
172 [7] 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
173
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
174
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
175 ]]></help>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
176
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
177 <citations>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
178 <expand macro="common_citations" />
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
179 <citation type="bibtex">@ARTICLE{Cook77,
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
180 author = {R.-D. Cook},
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
181 title = {Detection of Influential Observation in Linear Regression},
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
182 journal = {Technometrics},
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
183 year = {1977},
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
184 month = {February}
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
185 }</citation>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
186 <citation type="bibtex">@ARTICLE{Bourgon10,
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
187 author = {R. Bourgon, R. Gentleman, and W. Huber},
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
188 title = {Independent filtering increases detection power for high-throughput experiments},
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
189 journal = {PNAS},
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
190 year = {2010},
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
191 volume = {107},
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
192 number = {21},
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
193 pages = {9546–9551},
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
194 note = {URL: http://www.pnas.org/content/107/21/9546.long}
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
195 }</citation>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
196 </citations>
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
197
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
198 </tool>