annotate geneBody_coverage.xml @ 3:01a37ee82a1a

Uploaded
author nilesh
date Mon, 29 Jul 2013 12:24:37 -0400
parents dc3b3b88fbab
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
1 <tool id="geneBody_coverage" name="Gene Body Converage (BAM)">
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
2 <description>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
3 Read coverage over gene body.
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
4 </description>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
5 <requirements>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
6 <requirement type="package" version="2.15.1">R</requirement>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
7 <requirement type="package" version="2.3.7">rseqc</requirement>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
8 </requirements>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
9 <command interpreter="python">
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
10 geneBody_coverage.py -i $input -r $refgene -o output
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
11 </command>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
12 <inputs>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
13 <param name="input" type="data" label="Input .bam file" format="bam" />
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
14 <param name="refgene" type="data" label="Reference Genome" format="bed" />
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
15 </inputs>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
16 <outputs>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
17 <data name="outputpdf" format="pdf" from_work_dir="output.geneBodyCoverage.pdf" />
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
18 <data name="outputr" format="r" from_work_dir="output.geneBodyCoverage_plot.r" />
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
19 <data name="outputtxt" format="txt" from_work_dir="output.geneBodyCoverage.txt" />
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
20 </outputs>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
21 <tests>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
22 <test>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
23 <param name="input" value="Pairend_nonStrandSpecific_36mer_Human_hg19.bam" />
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
24 <param name="refgene" value="hg19_RefSeq.bed" />
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
25 <output name="outputpdf" file="gbcout.geneBodyCoverage.pdf" />
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
26 <output name="outputr" file="gbcout.geneBodyCoverage_plot.r" />
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
27 <output name="outputtxt" file="gbcout.geneBodyCoverage.txt" />
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
28 </test>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
29 </tests>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
30 <help>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
31 .. image:: https://code.google.com/p/rseqc/logo?cct=1336721062
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
32
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
33 -----
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
34
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
35 About RSeQC
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
36 +++++++++++
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
37
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
38 The RSeQC package provides a number of useful modules that can comprehensively evaluate high throughput sequence data especially RNA-seq data. “Basic modules” quickly inspect sequence quality, nucleotide composition bias, PCR bias and GC bias, while “RNA-seq specific modules” investigate sequencing saturation status of both splicing junction detection and expression estimation, mapped reads clipping profile, mapped reads distribution, coverage uniformity over gene body, reproducibility, strand specificity and splice junction annotation.
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
39
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
40 The RSeQC package is licensed under the GNU GPL v3 license.
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
41
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
42 Inputs
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
43 ++++++++++++++
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
44
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
45 Input BAM/SAM file
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
46 Alignment file in BAM/SAM format.
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
47
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
48 Reference gene model
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
49 Gene Model in BED format.
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
50
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
51
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
52 Outputs
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
53 ++++++++++++++
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
54
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
55 Read coverage over gene body. This module is used to check if reads coverage is uniform and if there is any 5’/3’ bias. This module scales all transcripts to 100 nt and calculates the number of reads covering each nucleotide position. Finally, it generates a plot illustrating the coverage profile along the gene body. NOTE: this module requires lots of memory for large BAM files, because it load the entire BAM file into memory. We add another script "geneBody_coverage2.py" into v2.3.1 which takes bigwig (instead of BAM) as input. It only use 200M RAM, but users need to convert BAM into WIG, and then WIG into BigWig.
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
56
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
57 Example output:
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
58 .. image:: http://dldcc-web.brc.bcm.edu/lilab/liguow/RSeQC/figure/geneBody_coverage.png
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
59
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
60
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
61
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
62 </help>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
63 </tool>