Mercurial > repos > nilesh > rseqc

comparison read_NVC.xml @ 38:a447651be8ee

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