annotate deseq2.xml @ 15:ff74cd9b0414 draft

Uploaded
author bgruening
date Thu, 05 Sep 2013 04:09:22 -0400
parents bb5c80d15e0a
children 1d2a02bc2208
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">
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
2 <description>Determines differentially expressed transcripts from read alignments</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>
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
7 <requirement type="set_environment">DESEQ2_SCRIPT_PATH</requirement>
1
c0dfa0f736aa Uploaded
bgruening
parents: 0
diff changeset
8 </requirements>
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
9 <command interpreter="Rscript">
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
10 deseq2.R
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
11 -o "$deseq_out"
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
12
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
13 #if $pdf:
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
14 -p "$plots"
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
15 #end if
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
16
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
17 -i "$input_matrix"
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
18
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
19 #if $filter_sel.filter_sel_opts == 'all_vs_all':
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
20 -s 'all_vs_all'
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
21 #else:
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
22 -s ## build a string like '1,2 5,6'
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
23 "${filter_sel.control_cols} ${filter_sel.experiement_cols}"
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
24
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
25 #set $temp_factor_list = list()
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
26 #set $is_multi_factor_analysis = False
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
27 #for $factor in $filter_sel.factor:
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
28 #set $is_multi_factor_analysis = True
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
29 $temp_factor_list.append( '%s:%s' % ($factor.factor_name.replace(' ','_'), $factor.factor_index) )
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
30 #end for
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
31
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
32 #if $is_multi_factor_analysis:
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
33 -f "#echo ' '.join( $temp_factor_list )#"
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
34 #end if
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
35 #end if
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
36
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
37 </command>
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
38 <stdio>
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
39 <regex match="Execution halted"
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
40 source="both"
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
41 level="fatal"
15
ff74cd9b0414 Uploaded
bgruening
parents: 14
diff changeset
42 description="Execution halted." />
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
43 <regex match="Input-Error 01"
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
44 source="both"
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
45 level="fatal"
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
46 description="Error in your input parameters: Make sure you only apply factors to selected samples." />
15
ff74cd9b0414 Uploaded
bgruening
parents: 14
diff changeset
47 <regex match="Error in"
ff74cd9b0414 Uploaded
bgruening
parents: 14
diff changeset
48 source="both"
ff74cd9b0414 Uploaded
bgruening
parents: 14
diff changeset
49 level="fatal"
ff74cd9b0414 Uploaded
bgruening
parents: 14
diff changeset
50 description="An undefined error occured, please check your intput carefully and contact your administrator." />
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
51 </stdio>
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
52 <inputs>
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
53 <param format="tabular" name="input_matrix" type="data" label="Countmatrix" help="You can create a count matrix with the tool ..."/>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
54
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
55 <conditional name="filter_sel">
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
56 <param name="filter_sel_opts" type="select" label="Select properties to filter">
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
57 <option value="all_vs_all">All against all</option>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
58 <option value="specific">specific</option>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
59 </param>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
60 <when value="specific">
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
61
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
62 <param name="control_cols" label="Select columns containing treatment." type="data_column" data_ref="input_matrix"
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>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
66
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
67 <param name="experiement_cols" label="Select columns containing treatment." type="data_column" data_ref="input_matrix"
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
68 numerical="True" multiple="true" use_header_names="true" size="120" display="checkboxes">
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
69 <validator type="no_options" message="Please select at least one column."/>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
70 </param>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
71
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
72 <repeat name="factor" title="Include multi-factor analysis">
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
73 <param name="factor_name" type="text" value="Factor Name" label="Specify a factor name" help=""/>
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
74
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
75 <param name="factor_index" label="Select columns that are associated with a factor." type="data_column" data_ref="input_matrix"
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
76 numerical="True" multiple="true" use_header_names="true" size="120" display="checkboxes">
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
77 <validator type="no_options" message="Please select at least one column."/>
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
78 </param>
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
79 </repeat>
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
80
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
81 </when>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
82 <when value="all_v_all" />
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
83 </conditional>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
84
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
85 <param name="pdf" type="boolean" truevalue="" falsevalue="" checked="true" label="Visualising the analysis results"
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
86 help="output an additional PDF file" />
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
87
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
88 </inputs>
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
89
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
90 <outputs>
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
91 <data format="tabular" name="deseq_out" label="DESeq2 result file on ${on_string}"/>
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
92 <data format="pdf" name="plots" label="DESeq2 plots on ${on_string}">
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
93 <filter>pdf == True</filter>
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
94 </data>
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
95 </outputs>
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
96
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
97 <help>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
98
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
99 .. class:: infomark
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
100
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
101 **What it does**
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
102
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
103 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
104
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
105
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
106 **Inputs**
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
107
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
108 DESeq2_ requires one count matrix as input file. You can use the tool
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
109
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
110
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
111
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
112 **Output**
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
113
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
114 DESeq2_ generates a tabular file containing the different columns and optional visualized results as PDF.
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
115
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
116 ====== ==========================================================
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
117 Column Description
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
118 ------ ----------------------------------------------------------
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
119 1 Sample ID (corresponds to the header in your count matrix)
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
120 2 Gene Identifiers
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
121 3 mean normalised counts, averaged over all samples from both conditions
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
122 4 the logarithm (to basis 2) of the fold change
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
123 5 standard error estimate for the log2 fold change estimate
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
124 6 p value for the statistical significance of this change
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
125 7 p value adjusted for multiple testing with the Benjamini-Hochberg procedure
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
126 which controls false discovery rate (FDR)
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
127 ====== ==========================================================
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
128
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
129
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
130 ------
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
131
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
132 **References**
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
133
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
134 DESeq2_ Authors: Michael Love (MPIMG Berlin), Simon Anders, Wolfgang Huber (EMBL Heidelberg)
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
135
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
136 If _DESeq2_ is used to obtain results for scientific publications it
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
137 should be cited as [1]_. A paper describing DESeq2_ is in preparation.
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
138
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
139
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
140
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
141 .. [1] Anders, S and Huber, W (2010): `Differential expression analysis for sequence count data`_.
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
142
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
143 .. _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
144 .. _DESeq2: http://master.bioconductor.org/packages/release/bioc/html/DESeq2.html
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
145
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
146
14
bb5c80d15e0a Uploaded
bgruening
parents: 13
diff changeset
147 </help>
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
148 </tool>