annotate dexseq.xml @ 19:b7235a9b1881 draft

Uploaded
author pavanvidem
date Thu, 03 Sep 2015 05:25:49 -0400
parents b7e9bf50295c
children 71cb8c5ae8bd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
28f42c7e6b12 Uploaded
pavanvidem
parents: 1
diff changeset
1 <tool id="dexseq" name="DEXSeq" version="1.0">
15
b7e9bf50295c Uploaded
pavanvidem
parents: 13
diff changeset
2 <description>Determines differential exon usage from count tables</description>
1
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
3 <requirements>
13
7aa851f87974 Uploaded
pavanvidem
parents: 11
diff changeset
4 <requirement type="package" version="3.2.0">R</requirement>
19
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
5 <requirement type="package" version="4.0.3">tiff</requirement>
13
7aa851f87974 Uploaded
pavanvidem
parents: 11
diff changeset
6 <requirement type="package" version="1.14.2">DEXSeq</requirement>
1
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
7 </requirements>
11
defd31925739 Uploaded
pavanvidem
parents: 2
diff changeset
8 <code file="dexseq_helper.py" />
1
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
9 <command>
19
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
10 mkdir ./html_out ;
1
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
11 #import json
19
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
12 Rscript $__tool_directory__/dexseq.R
13
7aa851f87974 Uploaded
pavanvidem
parents: 11
diff changeset
13 -o "$dexseq_out"
1
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
14 -p 12
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
15 #set $temp_factor_names = list()
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
16 #for $factor in $rep_factorName:
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
17 #set $temp_factor = list()
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
18 #for $level in $factor.rep_factorLevel:
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
19 #set $count_files = list()
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
20 #for $file in $level.countsFile:
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
21 $count_files.append(str($file))
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
22 #end for
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
23 $temp_factor.append( {str($level.factorLevel): $count_files} )
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
24 #end for
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
25 $temp_factor_names.append([str($factor.factorName), $temp_factor])
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
26 #end for
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
27 -f '#echo json.dumps(temp_factor_names)#'
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
28 -a $gtf
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
29 #if $report:
19
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
30 -r ./html_out
1
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
31 #end if
15
b7e9bf50295c Uploaded
pavanvidem
parents: 13
diff changeset
32 -c $fdr_cutoff;
19
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
33 mkdir $htmlreport.extra_files_path;
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
34 cp ./html_out/testForDEU.html $htmlreport ;
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
35 cp -r ./html_out/* $htmlreport.extra_files_path ;
1
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
36 </command>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
37 <stdio>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
38 <regex match="Execution halted"
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
39 source="both"
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
40 level="fatal"
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
41 description="Execution halted." />
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
42 <regex match="Input-Error 01"
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
43 source="both"
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
44 level="fatal"
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
45 description="Error in your input parameters: Make sure you only apply factors to selected samples." />
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
46 <regex match="Error in"
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
47 source="both"
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
48 level="fatal"
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
49 description="An undefined error occured, please check your intput carefully and contact your administrator." />
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
50 </stdio>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
51 <inputs>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
52 <param name="gtf" type="data" label="GTF file created from dexseq_count tool"/>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
53 <repeat name="rep_factorName" title="Factor" min="1">
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
54 <param name="factorName" type="text" value="FactorName" label="Specify a factor name"
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
55 help="Only letters, numbers and underscores will be retained in this field">
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
56 <sanitizer>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
57 <valid initial="string.letters,string.digits"><add value="_" /></valid>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
58 </sanitizer>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
59 </param>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
60 <repeat name="rep_factorLevel" title="Factor level" min="2" max="2" default="2">
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
61 <param name="factorLevel" type="text" value="FactorLevel" label="Specify a factor level"
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
62 help="Only letters, numbers and underscores will be retained in this field">
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
63 <sanitizer>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
64 <valid initial="string.letters,string.digits"><add value="_" /></valid>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
65 </sanitizer>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
66 </param>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
67 <param name="countsFile" type="data" multiple="true" label="Counts file"/>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
68 </repeat>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
69 </repeat>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
70 <param name="report" type="boolean" truevalue="" falsevalue="" checked="true"
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
71 label="Visualise the analysis results?"
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
72 help="output an additional html file" />
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
73 <param name="fdr_cutoff" type="float" min="0" max="1" value="0.05" label="All the genes under this FDR threshold will be shown in the html report."/>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
74 </inputs>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
75
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
76 <outputs>
15
b7e9bf50295c Uploaded
pavanvidem
parents: 13
diff changeset
77 <data format="tabular" name="dexseq_out" label="DEXSeq result file on ${on_string}"/>
b7e9bf50295c Uploaded
pavanvidem
parents: 13
diff changeset
78 <data format="html" name="htmlreport" label="DEXSeq report on ${on_string}">
b7e9bf50295c Uploaded
pavanvidem
parents: 13
diff changeset
79 <filter>report == True</filter>
1
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
80 </data>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
81 </outputs>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
82 <code file="dexseq_helper.py" />
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
83 <help>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
84
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
85 .. class:: infomark
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
86
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
87 **What it does**
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
88
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
89 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
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
90
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
91
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
92 **Inputs**
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
93
19
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
94 DEXSeq_ takes count tables that generated from the dexseq_count as input. Count tables must be generated for each sample individually. DEXSeq 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. Primary factor should always be named as 'condition'. 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.
1
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
95
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
96 The following table gives some examples of factors and their levels:
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
97
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
98 ========= ============== ===============
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
99 Factor Factor level 1 Factor level 2
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
100 --------- -------------- ---------------
19
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
101 condition Knockdown Wildtype
1
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
102 --------- -------------- ---------------
19
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
103 treatment Treated Untreated
1
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
104 --------- -------------- ---------------
19
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
105 timePoint Day4 Day1
1
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
106 --------- -------------- ---------------
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
107 SeqType SingleEnd PairedEnd
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
108 --------- -------------- ---------------
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
109 Gender Female Male
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
110 ========= ============== ===============
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
111
19
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
112 *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 'condition' given in above table, DEXSeq computes fold changes of 'Knockdown' samples against 'Wildtype', i.e. the values correspond to up or down regulations of genes in Knockdown samples.
1
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
113
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
114 **Output**
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
115
19
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
116 DEXSeq_ generates a tabular file containing the different columns and an optional html report.
1
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
117
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
118 ====== ==========================================================
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
119 Column Description
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
120 ------ ----------------------------------------------------------
19
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
121 1 Gene and exon Identifiers
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
122 2 group/gene identifier
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
123 3 feature/exon identifier
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
124 4 mean of the counts across samples in each feature/exon
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
125 5 exon dispersion estimate
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
126 6 LRT statistic
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
127 7 LRT p-value
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
128 8 BH adjusted p-values
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
129 9 exon usage coefficient factorLevel 2
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
130 10 exon usage coefficient factorLevel 1
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
131 11 relative exon usage fold changes
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
132 12 GRanges object of the coordinates of the exon/feature
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
133 13 matrix of integer counts, of each column containing a sample
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
134 14 list of transcripts overlapping with the exon
1
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
135 ====== ==========================================================
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
136
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
137
19
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
138 .. _DEXSeq: http://master.bioconductor.org/packages/release/bioc/html/DEXSeq.html
1
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
139
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
140 </help>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
141 <citations>
19
b7235a9b1881 Uploaded
pavanvidem
parents: 15
diff changeset
142 <citation type="doi">10.1101/gr.133744.111</citation>
1
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
143 </citations>
bc7eab5753a8 Uploaded
pavanvidem
parents:
diff changeset
144 </tool>