annotate read_NVC.xml @ 31:cc5eaa9376d8

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