annotate read_NVC.xml @ 0:f85fac5a4dce draft

Import from BitBucket tip
author lparsons
date Mon, 07 Oct 2013 14:36:38 -0400
parents
children 5eef4ef0ab25
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_read_NVC" name="Read NVC" version="1.1">
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
2 <description>to check the nucleotide composition bias</description>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
3 <requirements>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
4 <requirement type="package" version="2.11.0">R</requirement>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
5 <requirement type="package" version="1.7.1">numpy</requirement>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
6 <requirement type="package" version="2.3.7">rseqc</requirement>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
7 </requirements>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
8 <command>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
9 read_NVC.py -i $input -o output $nx
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
10 </command>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
11 <stdio>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
12 <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
13 <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
14 </stdio>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
15 <inputs>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
16 <param name="input" type="data" format="bam,sam" label="input bam/sam file" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
17 <param name="nx" type="boolean" value="false" truevalue="-x" falsevalue="" label="Include N,X in NVC plot"/>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
18 </inputs>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
19 <outputs>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
20 <data format="xls" name="outputxls" from_work_dir="output.NVC.xls" label="${tool.name} on ${on_string} (XLS)" />
f85fac5a4dce Import from BitBucket tip
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)" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
22 <data format="pdf" name="outputpdf" from_work_dir="output.NVC_plot.pdf" label="${tool.name} on ${on_string} (PDF)" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
23 </outputs>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
24 <help>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
25 read_NVC.py
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
26 +++++++++++
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
27
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
28 This module is used to check the nucleotide composition bias. Due to random priming, certain
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
29 patterns are over represented at the beginning (5'end) of reads. This bias could be easily
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
30 examined by NVC (Nucleotide versus cycle) plot. NVC plot is generated by overlaying all
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
31 reads together, then calculating nucleotide composition for each position of read
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
32 (or each sequencing cycle). In ideal condition (genome is random and RNA-seq reads is
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
33 randomly sampled from genome), we expect A%=C%=G%=T%=25% at each position of reads.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
34
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
35 NOTE: this program expect a fixed read length
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
36
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
37 Inputs
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
38 ++++++++++++++
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
39
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
40 Input BAM/SAM file
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
41 Alignment file in BAM/SAM format.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
42
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
43 Include N,X in NVC plot
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
44 Plots N and X alongside A, T, C, and G in plot.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
45
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
46 Output
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
47 ++++++++++++++
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
48
f85fac5a4dce Import from BitBucket tip
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.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
50
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
51
f85fac5a4dce Import from BitBucket tip
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)
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
53 2. output.NVC_plot.r: R script to generate NVC plot.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
54 3. output.NVC_plot.pdf: NVC plot.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
55
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
56
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
57 .. image:: http://rseqc.sourceforge.net/_images/NVC_plot.png
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
58 :height: 600 px
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
59 :width: 600 px
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
60 :scale: 80 %
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
61
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
62 -----
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
63
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
64 About RSeQC
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
65 +++++++++++
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
66
f85fac5a4dce Import from BitBucket tip
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.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
68
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
69 The RSeQC package is licensed under the GNU GPL v3 license.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
70
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
71 .. image:: http://rseqc.sourceforge.net/_static/logo.png
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
72
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
73 .. _RSeQC: http://rseqc.sourceforge.net/
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
74
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
75
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
76 </help>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
77 </tool>