annotate dexseq_count.xml @ 25:abf8b6260cae draft default tip

Uploaded
author pavanvidem
date Wed, 23 Sep 2015 09:31:36 -0400
parents f5cc1f2a6e96
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
1 <tool id="dexseq_count" name="DEXSeq-Count" version="1.0">
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
2 <description>Prepare and count exon abundancies from RNA-seq data</description>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
3 <requirements>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
4 <requirement type="package" version="3.1.0">R</requirement>
23
f5cc1f2a6e96 Uploaded
pavanvidem
parents: 22
diff changeset
5 <requirement type="package" version="1.14.2">dexseq</requirement>
22
71cb8c5ae8bd Uploaded
pavanvidem
parents: 21
diff changeset
6 <requirement type="package">htseq</requirement>
71cb8c5ae8bd Uploaded
pavanvidem
parents: 21
diff changeset
7 <requirement type="package">pysam</requirement>
19
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
8 </requirements>
22
71cb8c5ae8bd Uploaded
pavanvidem
parents: 21
diff changeset
9 <command>
19
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
10 #if $mode.mode_select == "prepare":
22
71cb8c5ae8bd Uploaded
pavanvidem
parents: 21
diff changeset
11 python \$DEXSEQ_ROOT/python_scripts/dexseq_prepare_annotation.py -r $mode.aggregate $mode.gtffile $flattened_gtf_out
19
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
12 #elif $mode.mode_select == "count":
22
71cb8c5ae8bd Uploaded
pavanvidem
parents: 21
diff changeset
13 python \$DEXSEQ_ROOT/python_scripts/dexseq_count.py -f bam -p $mode.paired -s $mode.stranded -a $mode.qual -r $mode.order $mode.flattened_gtf_in $mode.bamfile $counts_file
19
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
14 #end if
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
15 </command>
22
71cb8c5ae8bd Uploaded
pavanvidem
parents: 21
diff changeset
16 <stdio>
71cb8c5ae8bd Uploaded
pavanvidem
parents: 21
diff changeset
17 <!-- Anything other than zero is an error -->
71cb8c5ae8bd Uploaded
pavanvidem
parents: 21
diff changeset
18 <exit_code range="1:" />
71cb8c5ae8bd Uploaded
pavanvidem
parents: 21
diff changeset
19 <exit_code range=":-1" />
71cb8c5ae8bd Uploaded
pavanvidem
parents: 21
diff changeset
20 <!-- In case the return code has not been set propery check stderr too -->
71cb8c5ae8bd Uploaded
pavanvidem
parents: 21
diff changeset
21 <regex match="Error:" />
71cb8c5ae8bd Uploaded
pavanvidem
parents: 21
diff changeset
22 <regex match="Exception:" />
71cb8c5ae8bd Uploaded
pavanvidem
parents: 21
diff changeset
23 </stdio>
19
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
24 <inputs>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
25 <conditional name="mode">
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
26 <param name="mode_select" type="select" label="Mode of operation">
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
27 <option value="prepare">Prepare annotation</option>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
28 <option value="count">Count reads</option>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
29 </param>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
30 <when value="prepare">
21
45022897fb7d Uploaded
pavanvidem
parents: 19
diff changeset
31 <param name="gtffile" type="data" format="gff" label="GTF file"/>
19
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
32 <param name="aggregate" type="boolean" checked="True" truevalue="yes" falsevalue="no" label="Aggretare genes with exons?" help="Indicates whether two or more genes sharing an exon should be merged into an 'aggregate gene'. If 'no', the exons that can not be assiged to a single gene are ignored."/>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
33 </when>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
34 <when value="count">
21
45022897fb7d Uploaded
pavanvidem
parents: 19
diff changeset
35 <param name="bamfile" type="data" format="bam" label="Input bam file"/>
45022897fb7d Uploaded
pavanvidem
parents: 19
diff changeset
36 <param name="flattened_gtf_in" type="data" format="gff" label="DEXSeq compatible GTF file" help="Created by prepare mode"/>
45022897fb7d Uploaded
pavanvidem
parents: 19
diff changeset
37 <param name="paired" type="boolean" checked="True" truevalue="yes" falsevalue="no" label="Is libray paired end?"/>
19
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
38 <param name="stranded" type="select" label="Is library strand specific?">
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
39 <option value="no">No</option>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
40 <option value="yes">Yes</option>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
41 <option value="reverse">Yes, but reverse</option>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
42 </param>
21
45022897fb7d Uploaded
pavanvidem
parents: 19
diff changeset
43 <param name="qual" type="integer" value="10" label="Skip all reads with alignment quality lower than the given minimum value"/>
19
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
44 <param name="order" type="select" label="Sorting order of alignments" help="If you generated your alignments using tophat, they are by default position sorted. Ignored for single-end data">
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
45 <option value="pos">By position</option>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
46 <option value="name">By name</option>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
47 </param>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
48 </when>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
49 </conditional>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
50 </inputs>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
51
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
52 <outputs>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
53 <data format="tabular" name="counts_file" label="DEXSeq count reads on ${on_string}">
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
54 <filter>(mode['mode_select'] == 'count')</filter>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
55 </data>
21
45022897fb7d Uploaded
pavanvidem
parents: 19
diff changeset
56 <data format="gff" name="flattened_gtf_out" label="DEXSeq prepare annotation ${on_string}">
19
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
57 <filter>(mode['mode_select'] == 'prepare')</filter>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
58 </data>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
59 </outputs>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
60
23
f5cc1f2a6e96 Uploaded
pavanvidem
parents: 22
diff changeset
61 <tests>
f5cc1f2a6e96 Uploaded
pavanvidem
parents: 22
diff changeset
62 <test>
f5cc1f2a6e96 Uploaded
pavanvidem
parents: 22
diff changeset
63 <param name="mode_select" value="prepare" />
f5cc1f2a6e96 Uploaded
pavanvidem
parents: 22
diff changeset
64 <param name="gtffile" ftype="gff" value="original.gtf"/>
f5cc1f2a6e96 Uploaded
pavanvidem
parents: 22
diff changeset
65 <param name="aggregate" value="True"/>
f5cc1f2a6e96 Uploaded
pavanvidem
parents: 22
diff changeset
66 <output name="flattened_gtf_out" file="flattened.gtf" ftype="gff"/>
f5cc1f2a6e96 Uploaded
pavanvidem
parents: 22
diff changeset
67 </test>
f5cc1f2a6e96 Uploaded
pavanvidem
parents: 22
diff changeset
68 </tests>
f5cc1f2a6e96 Uploaded
pavanvidem
parents: 22
diff changeset
69
19
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
70 <help>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
71
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
72 .. class:: infomark
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
73
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
74 **What it does**
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
75
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
76 The main goal of this tol is to count the number of reads/fragments per exon of each gene in RNA-seq sample. In addition it also prepares your annotation gtf file compatible for counting.
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
77
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
78
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
79 **Inputs**
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
80
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
81 Mode-preprare: Takes a normal gtf file as input. For example from ensembl database.
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
82 Mode-count: Inputs are flattened gtf file and BAM file. The flattened gtf file can be generated from 'prepare' mode of this tool.
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
83
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
84 **Output**
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
85
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
86 Mode-preprare: Flattened gtf file that contains only exons with corresponding gene ids from given gtf file. Sometimes two or more genes sharing an exon will be merged into an 'aggregate gene' if the aggregate option was used.
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
87 Mode-count: Two column tab-delimeted file with exon ids and their read counts.
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
88
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
89 .. _DEXSeq: http://master.bioconductor.org/packages/release/bioc/html/DEXSeq.html
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
90
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
91
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
92 </help>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
93 <citations>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
94 <citation type="doi">10.1101/gr.133744.111</citation>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
95 </citations>
b7235a9b1881 Uploaded
pavanvidem
parents:
diff changeset
96 </tool>