Mercurial > repos > nilesh > rseqc

annotate read_NVC.xml @ 46:68ada7ca4cc4 draft

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