annotate deseq2.xml @ 19:a1aa11e02862 draft

Uploaded
author bgruening
date Mon, 30 Sep 2013 12:28:02 -0400
parents 72613128bd65
children bbea9c694b34
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15
ff74cd9b0414 Uploaded
bgruening
parents: 14
diff changeset
1 <tool id="deseq2" name="DESeq2" version="2.0.1">
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
2 <description>Determines differentially expressed features from count data</description>
1
c0dfa0f736aa Uploaded
bgruening
parents: 0
diff changeset
3 <requirements>
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
4 <requirement type="binary">Rscript</requirement>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
5 <requirement type="R-module">DESeq2</requirement>
1
c0dfa0f736aa Uploaded
bgruening
parents: 0
diff changeset
6 <requirement type="package" version="3.0.1">R_3_0_1</requirement>
18
72613128bd65 Uploaded
bgruening
parents: 17
diff changeset
7 <requirement type="package" version="1.0.17">deseq2</requirement>
72613128bd65 Uploaded
bgruening
parents: 17
diff changeset
8 <!--<requirement type="set_environment">DESEQ2_SCRIPT_PATH</requirement>-->
1
c0dfa0f736aa Uploaded
bgruening
parents: 0
diff changeset
9 </requirements>
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
10 <command interpreter="Rscript">
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
11 #import simplejson
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
12 deseq2.R
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
13 -o "$deseq_out"
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
14 --outfilefiltered "$deseq_out_filtered"
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
15
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
16 #if $pdf:
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
17 -p "$plots"
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
18 #end if
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
19
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
20 -i "$input_matrix"
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
21
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
22 #set $temp_factor_name = list()
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
23 #for $factor in $rep_factorName:
18
72613128bd65 Uploaded
bgruening
parents: 17
diff changeset
24 #set $temp_factor = dict()
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
25 #for $level in $factor.rep_factorLevel:
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
26 ##$temp_factor_list.append( '%s::%s:%s' % ($factor.factorName.replace(' ','_'), $level.factorLevel, $level.factorIndex) )
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
27 $temp_factor.update({str($level.factorLevel): map(int, str($level.factorIndex).split(','))})
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
28 #end for
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
29 $temp_factor_name.append([str($factor.factorName), $temp_factor])
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
30
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
31 #end for
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
32
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
33 ##-m "#echo ' '.join( $temp_factor_list )#"
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
34 -m '#echo simplejson.dumps(temp_factor_name)#'
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
35 ##--organism "$organism"
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
36 ##-t "$fittype"
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
37 -c $countthreshold
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
38 </command>
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
39 <stdio>
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
40 <regex match="Execution halted"
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
41 source="both"
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
42 level="fatal"
15
ff74cd9b0414 Uploaded
bgruening
parents: 14
diff changeset
43 description="Execution halted." />
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
44 <regex match="Input-Error 01"
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
45 source="both"
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
46 level="fatal"
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
47 description="Error in your input parameters: Make sure you only apply factors to selected samples." />
15
ff74cd9b0414 Uploaded
bgruening
parents: 14
diff changeset
48 <regex match="Error in"
ff74cd9b0414 Uploaded
bgruening
parents: 14
diff changeset
49 source="both"
ff74cd9b0414 Uploaded
bgruening
parents: 14
diff changeset
50 level="fatal"
ff74cd9b0414 Uploaded
bgruening
parents: 14
diff changeset
51 description="An undefined error occured, please check your intput carefully and contact your administrator." />
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
52 </stdio>
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
53 <inputs>
16
1d2a02bc2208 Uploaded
bgruening
parents: 15
diff changeset
54 <param format="tabular" name="input_matrix" type="data" label="Countmatrix" help="You can create a count matrix with the tool
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
55 'Count reads in features with htseq-count'"/>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
56
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
57 <repeat name="rep_factorName" title="Factor/Condition" min="1">
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
58 <param name="factorName" type="text" value="FactorName" label="Specify a factor name" help=""/>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
59 <repeat name="rep_factorLevel" title="Factor level" min="1">
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
60 <param name="factorLevel" type="text" value="FactorLevel" label="Specify a factor level" help=""/>
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
61
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
62 <param name="factorIndex" label="Select columns that are associated with this factor level" type="data_column" data_ref="input_matrix"
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
63 numerical="True" multiple="true" use_header_names="true" size="120" display="checkboxes">
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
64 <validator type="no_options" message="Please select at least one column."/>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
65 </param>
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
66 </repeat>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
67 </repeat>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
68 <!--
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
69 <param name="control_cols" type="select" display="checkboxes" multiple="true" optional="True" label="Select columns containing first condition"
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
70 dynamic_options="get_matrix_header( input_dataset=input_matrix )" help="insert useful info here">
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
71 <validator type="no_options" message="Please select at least one column."/>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
72 </param>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
73 <param name="experiement_cols" type="select" display="checkboxes" multiple="true" optional="True" label="Select columns containing second condition"
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
74 dynamic_options="get_matrix_header( input_dataset=input_matrix )" help="insert useful info here">
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
75 <validator type="no_options" message="Please select at least one column."/>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
76 </param>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
77
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
78 <repeat name="factor" title="factor">
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
79 <param name="factor_name" type="text" value="Factor Name" label="Specify a factor name"
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
80 help="Order of factors you add effects the design formual and hence effects whole analysis. Design formual will be created as follows: ~factor1+factor2+factor3+...+factorN+condition"/>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
81 <param name="factor_index" type="select" display="checkboxes" multiple="true" optional="True" label="Choose sample to compare with"
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
82 dynamic_options="get_matrix_header( input_dataset=input_matrix )" help="Select columns that are associated with a factor">
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
83 <validator type="no_options" message="Please select at least one column."/>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
84 </param>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
85 </repeat>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
86 -->
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
87 <!--param name="organism" size="10" type="select">
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
88 <option value="human">human</option>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
89 <option value="mouse">mouse</option>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
90 <option value="fly">fly</option>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
91 <option value="other">other</option>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
92 </param-->
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
93 <param name="countthreshold" size="10" type="float" value="10" label="Filter out features with mean normalized counts lower than this value"/>
16
1d2a02bc2208 Uploaded
bgruening
parents: 15
diff changeset
94 <param name="fittype" type="select" label="Type of fitting of dispersions to the mean intensity">
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
95 <option value="parametric">parametric</option>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
96 <option value="local">local</option>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
97 <option value="mean">mean</option>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
98 </param>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
99 <param name="pdf" type="boolean" truevalue="" falsevalue="" checked="true" label="Visualising the analysis results"
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
100 help="output an additional PDF files" />
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
101 </inputs>
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
102
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
103 <outputs>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
104 <data format="tabular" name="deseq_out" label="DESeq2 result file on ${on_string}"/>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
105 <data format="tabular" name="deseq_out_filtered" label="Independent filtering result file on ${on_string}"/>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
106 <data format="pdf" name="plots" label="DESeq2 plots on ${on_string}">
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
107 <filter>pdf == True</filter>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
108 </data>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
109 </outputs>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
110 <code file="matrix_helper.py" />
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
111
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
112 <help>
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
113
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
114 .. class:: infomark
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
115
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
116 **What it does**
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
117
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
118 Estimate variance-mean dependence in count data from high-throughput sequencing assays and test for differential expression based on a model using the negative binomial distribution
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
119
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
120
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
121 **Inputs**
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
122
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
123 DESeq2_ requires one count matrix as input file. You can use the tool
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
124
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
125
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
126
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
127 **Output**
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
128
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
129 DESeq2_ generates a tabular file containing the different columns and optional visualized results as PDF.
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
130
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
131 ====== ==========================================================
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
132 Column Description
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
133 ------ ----------------------------------------------------------
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
134 1 Gene Identifiers
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
135 2 mean normalised counts, averaged over all samples from both conditions
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
136 3 the logarithm (to basis 2) of the fold change
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
137 4 standard error estimate for the log2 fold change estimate
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
138 5 p value for the statistical significance of this change
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
139 6 p value adjusted for multiple testing with the Benjamini-Hochberg procedure
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
140 which controls false discovery rate (FDR)
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
141 ====== ==========================================================
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
142
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
143
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
144 ------
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
145
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
146 **References**
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
147
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
148 DESeq2_ Authors: Michael Love (MPIMG Berlin), Simon Anders, Wolfgang Huber (EMBL Heidelberg)
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
149
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
150 If _DESeq2_ is used to obtain results for scientific publications it
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
151 should be cited as [1]_. A paper describing DESeq2_ is in preparation.
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
152
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
153
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
154
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
155 .. [1] Anders, S and Huber, W (2010): `Differential expression analysis for sequence count data`_.
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
156
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
157 .. _Differential expression analysis for sequence count data: http://dx.doi.org/10.1186/gb-2010-11-10-r106
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
158 .. _DESeq2: http://master.bioconductor.org/packages/release/bioc/html/DESeq2.html
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
159
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
160
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
161 </help>
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
162 </tool>