annotate deseq2.xml @ 23:f8a59b35c397 draft

Uploaded
author bgruening
date Sat, 15 Nov 2014 06:18:50 -0500
parents aad8927093ac
children 1261539a93e9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
22
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
1 <tool id="iuc_deseq2" name="DESeq2" version="2.1.6.0">
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
2 <description>Determines differentially expressed features from count tables</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>
23
f8a59b35c397 Uploaded
bgruening
parents: 22
diff changeset
6 <requirement type="package" version="3.1.0">R</requirement>
22
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
7 <requirement type="package" version="1.6.1">deseq2</requirement>
1
c0dfa0f736aa Uploaded
bgruening
parents: 0
diff changeset
8 </requirements>
22
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
9 <code file="helper.py" />
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
10 <command interpreter="Rscript">
20
bbea9c694b34 Uploaded
bgruening
parents: 18
diff changeset
11 #import json
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
22
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
19
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
20 #set $temp_factor_names = list()
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
21 #for $factor in $rep_factorName:
22
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
22
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
23 #set $temp_factor = list()
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
24 #for $level in $factor.rep_factorLevel:
22
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
25 #set $count_files = list()
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
26 #for $file in $level.rep_countsFile:
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
27 $count_files.append(str($file.countsFile))
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
28 #end for
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
29 $temp_factor.append( {str($level.factorLevel): $count_files} )
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
30 #end for
22
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
31 $temp_factor_names.append([str($factor.factorName), $temp_factor])
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
32
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
33 #end for
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
34
22
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
35 -m '#echo json.dumps(temp_factor_names)#'
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
36 #if str($filtermode.mode) == "absolute":
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
37 -c $filtermode.count_abs
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
38 #elif str($filtermode.mode) == "quantile":
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
39 -c $filtermode.count_quant
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
40 #end if
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
41 --filtermode $filtermode.mode
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
42 </command>
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
43 <stdio>
22
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
44 <exit_code range="1:" />
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
45 <exit_code range=":-1" />
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
46 <regex match="Error:" />
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
47 <regex match="Exception:" />
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
48 </stdio>
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
49 <inputs>
22
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
50 <repeat name="rep_factorName" title="Factor" min="1">
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
51 <param name="factorName" type="text" value="FactorName" label="Specify a factor name"
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
52 help="Only letters, numbers and underscores will be retained in this field">
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
53 <sanitizer>
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
54 <valid initial="string.letters,string.digits"><add value="_" /></valid>
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
55 </sanitizer>
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
56 </param>
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
57 <repeat name="rep_factorLevel" title="Factor level" min="2" max="2" default="2">
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
58 <param name="factorLevel" type="text" value="FactorLevel" label="Specify a factor level"
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
59 help="Only letters, numbers and underscores will be retained in this field">
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
60 <sanitizer>
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
61 <valid initial="string.letters,string.digits"><add value="_" /></valid>
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
62 </sanitizer>
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
63 </param>
22
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
64 <repeat name="rep_countsFile" title="Biological replicate" min="1">
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
65 <param name="countsFile" type="data" label="Counts file"/>
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
66 </repeat>
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
67 </repeat>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
68 </repeat>
22
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
69 <conditional name="filtermode">
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
70 <param name="mode" type="select" label="Filter out features with following criteria">
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
71 <option value="absolute">Filter based on absolute normalized mean counts</option>
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
72 <option value="quantile">Filter based on quantiles</option>
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
73 </param>
22
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
74 <when value="absolute">
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
75 <param name="count_abs" size="10" type="float" value="10.0" label="Filter out features with mean normalized counts lower than this value"/>
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
76 </when>
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
77 <when value="quantile">
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
78 <param name="count_quant" size="10" type="float" value="10.0" min="0" max="100" label="Filter out features with mean normalized counts lower than this % of values" />
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
79 </when>
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
80 </conditional>
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
81 <param name="pdf" type="boolean" truevalue="" falsevalue="" checked="true" label="Visualising the analysis results"
20
bbea9c694b34 Uploaded
bgruening
parents: 18
diff changeset
82 help="output an additional PDF files" />
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
83 </inputs>
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
84
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
85 <outputs>
22
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
86 <data format="tabular" name="deseq_out" label="DESeq2 result file on ${on_string}"/>
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
87 <data format="tabular" name="deseq_out_filtered" label="Independent filtering result file on ${on_string}"/>
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
88 <data format="pdf" name="plots" label="DESeq2 plots on ${on_string}">
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
89 <filter>pdf == True</filter>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
90 </data>
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
91 </outputs>
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
92
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
93 <help>
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
94
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
95 .. class:: infomark
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
96
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
97 **What it does**
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
98
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
99 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
100
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
101
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
102 **Inputs**
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
103
22
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
104 DESeq2_ takes count tables that generated from the htseq-count as input. Count tables must be generated for each sample individually. DESeq2 is capable of handling multiple factors that effect your experiment. The first factor you input is considered as the primary factor that affects gene expressions. You also input several secondary factors that might influence your experiment. But the final output will be changes in genes due to primary factor in presence of secondary factors. Each factor has two levels/states. You need to select appropriate count table from your history for each factor level.
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
105
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
106 The following table gives some examples of factors and their levels:
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
107
22
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
108 ========= ============== ===============
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
109 Factor Factor level 1 Factor level 2
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
110 --------- -------------- ---------------
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
111 Treatment Treated Untreated
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
112 --------- -------------- ---------------
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
113 Condition Knockdown Wildtype
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
114 --------- -------------- ---------------
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
115 TimePoint Day4 Day1
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
116 --------- -------------- ---------------
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
117 SeqType SingleEnd PairedEnd
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
118 --------- -------------- ---------------
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
119 Gender Female Male
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
120 ========= ============== ===============
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
121
22
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
122 *Note*: Output log2 fold changes are based on primary factor level 1 vs. factor level2. Here the order of factor levels is important. For example, for the factor 'Treatment' given in above table, DESeq2 computes fold changes of 'Treated' samples against 'Untreated', i.e. the values correspond to up or down regulations of genes in Treated samples.
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
123
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
124 **Output**
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
125
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
126 DESeq2_ generates a tabular file containing the different columns and optional visualized results as PDF.
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
127
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
128 ====== ==========================================================
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
129 Column Description
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
130 ------ ----------------------------------------------------------
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
131 1 Gene Identifiers
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
132 2 mean normalised counts, averaged over all samples from both conditions
22
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
133 3 the logarithm (to basis 2) of the fold change (See the note in inputs section)
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
134 4 standard error estimate for the log2 fold change estimate
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
135 5 p value for the statistical significance of this change
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
136 6 p value adjusted for multiple testing with the Benjamini-Hochberg procedure
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
137 which controls false discovery rate (FDR)
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
138 ====== ==========================================================
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
139
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
140
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
141 .. _DESeq2: http://master.bioconductor.org/packages/release/bioc/html/DESeq2.html
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
142
17
a05999fd6e26 Uploaded
bgruening
parents: 16
diff changeset
143 </help>
22
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
144 <citations>
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
145 <citation type="doi">10.1101/002832</citation>
aad8927093ac Uploaded
bgruening
parents: 21
diff changeset
146 </citations>
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
147 </tool>