annotate geneBody_coverage2.xml @ 5:31a43978eaa9 draft default tip

Uploaded
author bgruening
date Sat, 25 Apr 2015 10:07:21 -0400
parents 49ed5952a8b8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
1 <tool id="rseqc_geneBody_coverage2" name="Gene Body Converage (Bigwig)" version="2.4">
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
2 <description>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
3 Read coverage over gene body
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
4 </description>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
5 <requirements>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
6 <requirement type="package" version="3.0.3">R</requirement>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
7 <requirement type="package" version="1.7.1">numpy</requirement>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
8 <requirement type="package" version="2.4">rseqc</requirement>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
9 </requirements>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
10 <command>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
11 geneBody_coverage2.py -i $input -r $refgene -o output
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
12 </command>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
13 <stdio>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
14 <exit_code range="1:" level="fatal" description="An error occured during execution, see stderr and stdout for more information" />
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
15 <regex match="[Ee]rror" source="both" description="An error occured during execution, see stderr and stdout for more information" />
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
16 </stdio>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
17 <inputs>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
18 <param name="input" type="data" label="Input bigwig file" format="bigwig" />
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
19 <param name="refgene" type="data" label="Reference Genome" format="bed" />
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
20 </inputs>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
21 <outputs>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
22 <data name="outputpdf" format="pdf" from_work_dir="output.geneBodyCoverage.pdf" label="${tool.name} on ${on_string} (PDF)" />
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
23 <data name="outputr" format="txt" from_work_dir="output.geneBodyCoverage_plot.r" label="${tool.name} on ${on_string} (R Script)" />
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
24 <data name="outputtxt" format="txt" from_work_dir="output.geneBodyCoverage.txt" label="${tool.name} on ${on_string} (Text)" />
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
25 </outputs>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
26 <help>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
27 geneBody_coverage2.py
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
28 +++++++++++++++++++++
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
29
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
30 Similar to geneBody_coverage.py. This module takes bigwig instead of BAM as input, and thus
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
31 requires much less memory. The BigWig file could be arbitrarily large.
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
32
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
33
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
34 Inputs
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
35 ++++++++++++++
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
36
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
37 Input BAM/SAM file
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
38 Alignment file in BAM/SAM format.
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
39
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
40 Reference gene model
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
41 Gene Model in BED format.
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
42
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
43
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
44 Outputs
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
45 ++++++++++++++
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
46
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
47 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.
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
48
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
49 Example output:
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
50 .. image:: http://dldcc-web.brc.bcm.edu/lilab/liguow/RSeQC/figure/geneBody_coverage.png
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
51 :height: 600 px
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
52 :width: 600 px
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
53 :scale: 80 %
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
54
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
55 -----
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
56
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
57 About RSeQC
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
58 +++++++++++
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
59
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
60 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.
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
61
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
62 The RSeQC package is licensed under the GNU GPL v3 license.
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
63
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
64 .. image:: http://rseqc.sourceforge.net/_static/logo.png
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
65
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
66 .. _RSeQC: http://rseqc.sourceforge.net/
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
67
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
68
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
69
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
70 </help>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
71 </tool>