annotate bam2wig.xml @ 38:a447651be8ee

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