annotate deseq2.xml @ 13:6d17a7d6fe9c draft

Uploaded
author bgruening
date Mon, 02 Sep 2013 10:09:37 -0400
parents c0dfa0f736aa
children bb5c80d15e0a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
1 <tool id="deseq2" name="DESeq2" version="2.0">
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"
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
12 -p "$plots"
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
13 -i "$input_matrix"
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
14
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
15 #if $filter_sel.filter_sel_opts == 'all_vs_all':
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
16 -s 'all_vs_all'
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
17 #else:
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
18 -s ## build a string like '1:2 5:6'
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
19 "${filter_sel.control_cols} ${filter_sel.experiement_cols}"
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
20 #end if
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
21
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
22 </command>
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
23 <inputs>
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
24 <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
25
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
26 <conditional name="filter_sel">
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
27 <param name="filter_sel_opts" type="select" label="Select properties to filter">
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
28 <option value="all_vs_all">All against all</option>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
29 <option value="specific">specific</option>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
30 </param>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
31 <when value="specific">
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
32
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
33 <param name="control_cols" label="Select columns containing treatment." type="data_column" data_ref="input_matrix"
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
34 numerical="True" multiple="true" use_header_names="true" size="120" display="checkboxes">
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
35 <validator type="no_options" message="Please select at least one column."/>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
36 </param>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
37
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
38 <param name="experiement_cols" label="Select columns containing treatment." type="data_column" data_ref="input_matrix"
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
39 numerical="True" multiple="true" use_header_names="true" size="120" display="checkboxes">
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
40 <validator type="no_options" message="Please select at least one column."/>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
41 </param>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
42
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
43 </when>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
44 <when value="all_v_all" />
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
45 </conditional>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
46
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
47 </inputs>
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
48
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
49 <outputs>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
50 <data format="txt" name="deseq_out" label="DESeq2 result file"/>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
51 <data format="pdf" name="plots" label="Plot collection"/>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
52 <data format="txt" name="log" label="DESeq2 log file"/>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
53 </outputs>
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
54
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
55 <help>
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
56
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
57 .. class:: infomark
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
58
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
59 **What it does**
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
60
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
61 `DESeq` is a tool for differential expression testing of RNA-Seq data.
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
62
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
63
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
64 **Inputs**
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
65
13
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
66 `DESeq` requires three input files to run:
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
67
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
68 1. Annotation file in GFF3, containing the necessary information about the transcripts that are to be quantified.
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
69 2. The BAM alignment files grouped into replicate groups, each containing several replicates. BAM files store the read alignments in a compressed format. They can be generated using the `SAM-to-BAM` tool in the NGS: SAM Tools section. (The script will also work with only two groups containing only a single replicate each. However, this analysis has less statistical power and is therefor not recommended.)
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
70
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
71 **Output**
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
72
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
73 `DESeq` generates a text file containing the gene name and the p-value.
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
74
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
75 ------
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
76
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
77 **Licenses**
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
78
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
79 If **DESeq** is used to obtain results for scientific publications it
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
80 should be cited as [1]_.
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
81
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
82 **References**
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
83
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
84 .. [1] Anders, S and Huber, W (2010): `Differential expression analysis for sequence count data`_.
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
85
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
86 .. _Differential expression analysis for sequence count data: http://dx.doi.org/10.1186/gb-2010-11-10-r106
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
87
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
88 ------
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
89
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
90 For more information see http://www.sequenceontology.org/gff3.shtml
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
91
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
92 **SAM/BAM format** The Sequence Alignment/Map (SAM) format is a
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
93 tab-limited text format that stores large nucleotide sequence
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
94 alignments. BAM is the binary version of a SAM file that allows for
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
95 fast and intensive data processing. The format specification and the
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
96 description of SAMtools can be found on
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
97 http://samtools.sourceforge.net/.
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
98
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
99 ------
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
100
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
101 DESeq-hts Wrapper Version 0.3 (Feb 2012)
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
102
6d17a7d6fe9c Uploaded
bgruening
parents: 1
diff changeset
103 </help>
0
b02d2083dd89 Uploaded
bgruening
parents:
diff changeset
104 </tool>