annotate bam2wig.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="bam2wig" name="BAM to Wiggle" version="1.1">
29
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
2 <description>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
3 converts all types of RNA-seq data from .bam to .wig
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
4 </description>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
5 <requirements>
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
6 <requirement type="package" version="2.11.0">R</requirement>
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
7 <requirement type="package" version="1.7.1">numpy</requirement>
29
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
8 <requirement type="package" version="2.3.7">rseqc</requirement>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
9 </requirements>
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
10 <command>
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
11 ln -s "${input}" "local_input.bam" &amp;&amp;
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
12 ln -s "${input.metadata.bam_index}" "local_input.bam.bai" &amp;&amp;
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
13 bam2wig.py -i "local_input.bam" -s $chromsize -o outfile
29
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
14
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
15 #if str($strand_type.strand_specific) == "pair"
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
16 -d
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
17 #if str($strand_type.pair_type) == "sd"
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
18 '1++,1--,2+-,2-+'
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
19 #else
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
20 '1+-,1-+,2++,2--'
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
21 #end if
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
22 #end if
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
23
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
24 #if str($strand_type.strand_specific) == "single"
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
25 -d
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
26 #if str($strand_type.single_type) == "s"
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
27 '++,--'
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
28 #else
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
29 '+-,-+'
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
30 #end if
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
31 #end if
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
32
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
33 #if $wigsum.wigsum_type
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
34 -t $wigsum.totalwig
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
35 #end if
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
36
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
37 #if $skipmultihits
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
38 -u
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
39 #end if
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
40 </command>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
41 <inputs>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
42 <param name="input" type="data" label="Input .bam File" format="bam" />
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
43 <param name="chromsize" type="data" label="Chromosome size file (tab or space separated)" format="txt,tabular" />
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
44 <param name="skipmultihits" type="boolean" label="Skip Multiple Hit Reads/Only Use Uniquely Mapped Reads" value="false" />
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
45 <conditional name="wigsum">
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
46 <param name="wigsum_type" type="boolean" label="Specify wigsum?" value="false">
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
47 </param>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
48 <when value="true">
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
49 <param name="totalwig" value="0" type="integer" label="specified wigsum" />
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
50 </when>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
51 <when value="false"></when>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
52 </conditional>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
53 <conditional name="strand_type">
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
54 <param name="strand_specific" type="select" label="Strand-specific?" value="none">
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
55 <option value="none">none</option>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
56 <option value="pair">Pair-End RNA-seq</option>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
57 <option value="single">Single-End RNA-seq</option>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
58 </param>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
59 <when value="pair">
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
60 <param name="pair_type" type="select" display="radio" label="Pair-End Read Type (format: mapped --> parent)" value="sd">
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
61 <option value="sd"> read1 (positive --> positive; negative --> negative), read2 (positive --> negative; negative --> positive)</option>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
62 <option value="ds">read1 (positive --> negative; negative --> positive), read2 (positive --> positive; negative --> negative)</option>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
63 </param>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
64 </when>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
65 <when value="single">
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
66 <param name="single_type" type="select" display="radio" label="Single-End Read Type (format: mapped --> parent)" value="s">
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
67 <option value="s">positive --> positive; negative --> negative</option>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
68 <option value="d">positive --> negative; negative --> positive</option>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
69 </param>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
70 </when>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
71 <when value="none"></when>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
72 </conditional>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
73 </inputs>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
74 <outputs>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
75 <data format="wig" name="output" from_work_dir="outfile.wig">
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
76 <filter>strand_type['strand_specific'] == 'none'</filter>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
77 </data>
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
78 <data format="wig" name="outputfwd" from_work_dir="outfile_Forward.wig" label="${tool.name} on ${on_string} (Forward Reads)">
29
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
79 <filter>strand_type['strand_specific'] != 'none'</filter>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
80 </data>
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
81 <data format="wig" name="outputrv" from_work_dir="outfile_Reverse.wig" label="${tool.name} on ${on_string} (Reverse Reads)">
29
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
82 <filter>strand_type['strand_specific'] != 'none'</filter>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
83 </data>
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
84 </outputs>
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
85 <stdio>
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
86 <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
87 <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
88 </stdio>
29
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
89 <help>
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
90 bam2wig.py
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
91 ++++++++++
29
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
92
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
93 Visualization is the most straightforward and effective way to QC your RNA-seq
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
94 data. For example, change of expression or new splicing can be easily checked
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
95 by visually comparing two RNA-seq tracks using genome browser such as UCSC_,
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
96 IGB_ and IGV_. `bam2wig.py` converts all types of RNA-seq data from BAM_
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
97 format into wiggle_ format in one-stop. wiggle_ files can then be easily
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
98 converted into bigwig_. Bigwig is indexed, binary format of wiggle file, and
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
99 it's particular useful to display large, continuous dataset on genome
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
100 browser.
29
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
101
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
102 Inputs
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
103 ++++++++++++++
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
104
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
105 Input BAM file
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
106 Alignment file in BAM format (SAM is not supported). BAM file will be sorted and indexed using samTools.
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
107
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
108 Chromosome size file
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
109 Tab or space separated text file with 2 columns: first column is chromosome name, second column is size of the chromosome. Chromosome names (such as "chr1") should be consistent between this file and BAM file.
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
110
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
111 Specified wigsum (default=none)
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
112 Specified wigsum. Wigsum of 100000000 equals to coverage achieved by 1 million 100nt reads. Ignore this option to disable normalization.
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
113
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
114 Skip multiple Hit reads
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
115 skips multiple hit reads or only use uniquely mapped reads
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
116
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
117 Strand-specific (default=none)
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
118 How read(s) were stranded during sequencing. If you are not sure about the strand rule, run infer_experiment.py
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
119
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
120 Outputs
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
121 ++++++++++++++
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
122
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
123 If RNA-seq is not strand specific, one wig file will be generated, if RNA-seq
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
124 is strand specific, two wig files corresponding to Forward and Reverse will be generated.
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
125
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
126 -----
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
127
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
128 About RSeQC
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
129 +++++++++++
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
130
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
131
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
132 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
133
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
134 The RSeQC package is licensed under the GNU GPL v3 license.
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
135
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
136 .. image:: http://rseqc.sourceforge.net/_static/logo.png
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
137
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
138 .. _RSeQC: http://rseqc.sourceforge.net/
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
139 .. _UCSC: http://genome.ucsc.edu/index.html
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
140 .. _IGB: http://bioviz.org/igb/
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
141 .. _IGV: http://www.broadinstitute.org/igv/home
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
142 .. _BAM: http://genome.ucsc.edu/goldenPath/help/bam.html
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
143 .. _wiggle: http://genome.ucsc.edu/goldenPath/help/wiggle.html
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
144 .. _bigwig: http://genome.ucsc.edu/FAQ/FAQformat.html#format6.1
29
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
145
907d4b021ff6 Uploaded
nilesh
parents:
diff changeset
146 </help>
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 29
diff changeset
147 </tool>