annotate bam_to_bigwig/README.txt @ 2:e2edfa478eb4

Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
author Brad Chapman <chapmanb@50mail.com>
date Wed, 05 Sep 2012 21:14:54 -0400
parents 0ff100a057ef
children 294e9dae5a9b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d2c1af657010 Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
brad-chapman
parents:
diff changeset
1 Convert a BAM file into a BigWig coverage file. This can be used directly from
d2c1af657010 Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
brad-chapman
parents:
diff changeset
2 Galaxy for display at UCSC. The advantage over standard Wiggle format is that
d2c1af657010 Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
brad-chapman
parents:
diff changeset
3 the data is stored in a compressed format and can be retrieved by genome
d2c1af657010 Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
brad-chapman
parents:
diff changeset
4 region. This allows you to view regions of arbitrarily large Wiggle file data
d2c1af657010 Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
brad-chapman
parents:
diff changeset
5 at UCSC while avoiding the upload costs.
d2c1af657010 Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
brad-chapman
parents:
diff changeset
6
2
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
7 History
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
8 -------
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
9
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
10 As of v0.1.0, the Galaxy tools uses a revised bam_to_bigwig.py script using
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
11 genomeCoverageBed and bedGraphToBigWig - this approach allows gaps/skpis to
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
12 be excluded from the coverage calculation, which is important for RNA-Seq.
0
d2c1af657010 Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
brad-chapman
parents:
diff changeset
13
2
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
14 Until v0.0.2, this Galaxy tool used the bam_to_wiggle.py script from
0
d2c1af657010 Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
brad-chapman
parents:
diff changeset
15 https://github.com/chapmanb/bcbb/blob/master/nextgen/scripts/bam_to_wiggle.py
2
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
16 which internally used pysam (and thus samtools) and wigToBigWig from UCSC.
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
17
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
18 Requirements
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
19 ------------
0
d2c1af657010 Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
brad-chapman
parents:
diff changeset
20
2
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
21 If you are installing this tool manually, place the Python script in the
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
22 same directory as the XML configuration file, or provide a soft link to it.
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
23 Ensure the following command line tools are on the system path:
1
0ff100a057ef Migrated tool version 0.0.2 from old tool shed archive to new tool shed repository
brad-chapman
parents: 0
diff changeset
24
2
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
25 pysam - Python interface to samtools (http://code.google.com/p/pysam/)
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
26 genomeCoverageBed - part of BedTools (http://code.google.com/p/bedtools/)
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
27 bedGraphToBigWig - from UCSC (http://hgdownload.cse.ucsc.edu/admin/exe/)
0
d2c1af657010 Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
brad-chapman
parents:
diff changeset
28
2
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
29 Credits
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
30 -------
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
31
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
32 Original script by Brad Chapman, revisions from Peter Cock including the
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
33 switch to using genomeCoverageBed and bedGraphToBigWig based on the work
e2edfa478eb4 Covert to use bedGraph intermediate with bedtools. Thanks to Peter Cock and Lance Parsons for the updates
Brad Chapman <chapmanb@50mail.com>
parents: 1
diff changeset
34 of Lance Parsons.