annotate geneBody_coverage.xml @ 1:5eef4ef0ab25 draft

Update R dependency version
author lparsons
date Mon, 07 Oct 2013 14:41:52 -0400
parents f85fac5a4dce
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
1 <tool id="rseqc_geneBody_coverage" name="Gene Body Converage (BAM)" version="1.1">
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
2 <description>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
3 Read coverage over gene body.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
4 </description>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
5 <requirements>
1
5eef4ef0ab25 Update R dependency version
lparsons
parents: 0
diff changeset
6 <requirement type="package" version="3.0.1">R</requirement>
0
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
7 <requirement type="package" version="1.7.1">numpy</requirement>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
8 <requirement type="package" version="2.3.7">rseqc</requirement>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
9 </requirements>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
10 <command>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
11 geneBody_coverage.py -i $input -r $refgene -o output
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
12 </command>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
13 <stdio>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
14 <exit_code range="1:" level="fatal" description="An error occured during execution, see stderr and stdout for more information" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
15 <regex match="[Ee]rror" source="both" description="An error occured during execution, see stderr and stdout for more information" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
16 </stdio>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
17 <inputs>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
18 <param name="input" type="data" label="Input .bam file" format="bam" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
19 <param name="refgene" type="data" label="Reference Genome" format="bed" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
20 </inputs>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
21 <outputs>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
22 <data name="outputpdf" format="pdf" from_work_dir="output.geneBodyCoverage.pdf" label="${tool.name} on ${on_string} (PDF)" />
f85fac5a4dce Import from BitBucket tip
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)" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
24 <data name="outputtxt" format="txt" from_work_dir="output.geneBodyCoverage.txt" label="${tool.name} on ${on_string} (Text)" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
25 </outputs>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
26 <help>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
27 geneBody_coverage.py
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
28 ++++++++++++++++++++
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
29
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
30 Read coverage over gene body. This module is used to check if reads coverage is uniform and
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
31 if there is any 5\'/3\' bias. This module scales all transcripts to 100 nt and calculates the
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
32 number of reads covering each nucleotide position. Finally, it generates a plot illustrating
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
33 the coverage profile along the gene body. NOTE: this module requires lots of memory for large
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
34 BAM files, because it load the entire BAM file into memory. We add another script
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
35 "geneBody_coverage2.py" into v2.3.1 which takes bigwig (instead of BAM) as input.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
36 It only use 200M RAM, but users need to convert BAM into WIG, and then WIG into BigWig.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
37
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
38 Inputs
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
39 ++++++++++++++
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
40
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
41 Input BAM/SAM file
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
42 Alignment file in BAM/SAM format.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
43
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
44 Reference gene model
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
45 Gene Model in BED format.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
46
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
47
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
48 Outputs
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
49 ++++++++++++++
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
50
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
51 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.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
52
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
53 Example output:
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
54 .. image:: http://rseqc.sourceforge.net/_images/geneBody_coverage.png
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
55 :height: 600 px
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
56 :width: 600 px
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
57 :scale: 80 %
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
58
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
59
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
60 -----
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
61
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
62 About RSeQC
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
63 +++++++++++
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
64
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
65 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.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
66
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
67 The RSeQC package is licensed under the GNU GPL v3 license.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
68
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
69 .. image:: http://rseqc.sourceforge.net/_static/logo.png
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
70
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
71 .. _RSeQC: http://rseqc.sourceforge.net/
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
72
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
73
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
74
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
75 </help>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
76 </tool>