annotate read_NVC.xml @ 38:a447651be8ee

Reupload 2.3.7 fix (tarball upload issues)
author lparsons
date Wed, 23 Jul 2014 10:14:01 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
38
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
1 <tool id="rseqc_read_NVC" name="Read NVC" version="1.1">
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
2 <description>to check the nucleotide composition bias</description>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
3 <requirements>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
4 <requirement type="package" version="3.0.1">R</requirement>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
5 <requirement type="package" version="1.7.1">numpy</requirement>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
6 <requirement type="package" version="2.3.7">rseqc</requirement>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
7 </requirements>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
8 <command>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
9 read_NVC.py -i $input -o output $nx
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
10 </command>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
11 <stdio>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
12 <exit_code range="1:" level="fatal" description="An error occured during execution, see stderr and stdout for more information" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
13 <regex match="[Ee]rror" source="both" description="An error occured during execution, see stderr and stdout for more information" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
14 </stdio>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
15 <inputs>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
16 <param name="input" type="data" format="bam,sam" label="input bam/sam file" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
17 <param name="nx" type="boolean" value="false" truevalue="-x" falsevalue="" label="Include N,X in NVC plot"/>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
18 </inputs>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
19 <outputs>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
20 <data format="xls" name="outputxls" from_work_dir="output.NVC.xls" label="${tool.name} on ${on_string} (XLS)" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
21 <data format="txt" name="outputr" from_work_dir="output.NVC_plot.r" label="${tool.name} on ${on_string} (R Script)" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
22 <data format="pdf" name="outputpdf" from_work_dir="output.NVC_plot.pdf" label="${tool.name} on ${on_string} (PDF)" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
23 </outputs>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
24 <help>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
25 read_NVC.py
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
26 +++++++++++
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
27
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
28 This module is used to check the nucleotide composition bias. Due to random priming, certain
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
29 patterns are over represented at the beginning (5'end) of reads. This bias could be easily
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
30 examined by NVC (Nucleotide versus cycle) plot. NVC plot is generated by overlaying all
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
31 reads together, then calculating nucleotide composition for each position of read
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
32 (or each sequencing cycle). In ideal condition (genome is random and RNA-seq reads is
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
33 randomly sampled from genome), we expect A%=C%=G%=T%=25% at each position of reads.
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
34
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
35 NOTE: this program expect a fixed read length
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
36
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
37 Inputs
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
38 ++++++++++++++
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
39
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
40 Input BAM/SAM file
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
41 Alignment file in BAM/SAM format.
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
42
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
43 Include N,X in NVC plot
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
44 Plots N and X alongside A, T, C, and G in plot.
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
45
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
46 Output
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
47 ++++++++++++++
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
48
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
49 This module is used to check the nucleotide composition bias. Due to random priming, certain patterns are over represented at the beginning (5'end) of reads. This bias could be easily examined by NVC (Nucleotide versus cycle) plot. NVC plot is generated by overlaying all reads together, then calculating nucleotide composition for each position of read (or each sequencing cycle). In ideal condition (genome is random and RNA-seq reads is randomly sampled from genome), we expect A%=C%=G%=T%=25% at each position of reads.
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
50
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
51
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
52 1. output.NVC.xls: plain text file, each row is position of read (or sequencing cycle), each column is nucleotide (A,C,G,T,N,X)
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
53 2. output.NVC_plot.r: R script to generate NVC plot.
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
54 3. output.NVC_plot.pdf: NVC plot.
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
55
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
56
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
57 .. image:: http://rseqc.sourceforge.net/_images/NVC_plot.png
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
58 :height: 600 px
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
59 :width: 600 px
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
60 :scale: 80 %
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
61
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
62 -----
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
63
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
64 About RSeQC
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
65 +++++++++++
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
66
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
67 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.
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
68
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
69 The RSeQC package is licensed under the GNU GPL v3 license.
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
70
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
71 .. image:: http://rseqc.sourceforge.net/_static/logo.png
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
72
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
73 .. _RSeQC: http://rseqc.sourceforge.net/
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
74
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
75
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
76 </help>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
77 </tool>