Spaces:
No application file
No application file
File size: 9,271 Bytes
b7731cd |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 |
# Copyright 2022 by Michiel de Hoon. All rights reserved.
#
# This file is part of the Biopython distribution and governed by your
# choice of the "Biopython License Agreement" or the "BSD 3-Clause License".
# Please see the LICENSE file that should have been included as part of this
# package.
"""Bio.Align support for BED (Browser Extensible Data) files.
The Browser Extensible Data (BED) format, stores a series of pairwise
alignments in a single file. Typically they are used for transcript to genome
alignments. BED files store the alignment positions and alignment scores, but
not the aligned sequences.
See http://genome.ucsc.edu/FAQ/FAQformat.html#format1
You are expected to use this module via the Bio.Align functions.
Coordinates in the BED format are defined in terms of zero-based start
positions (like Python) and aligning region sizes.
A minimal aligned region of length one and starting at first position in the
source sequence would have ``start == 0`` and ``size == 1``.
As we can see in this example, ``start + size`` will give one more than the
zero-based end position. We can therefore manipulate ``start`` and
``start + size`` as python list slice boundaries.
"""
import sys
import numpy
from Bio.Align import Alignment
from Bio.Align import interfaces
from Bio.Seq import Seq
from Bio.SeqRecord import SeqRecord
class AlignmentWriter(interfaces.AlignmentWriter):
"""Alignment file writer for the Browser Extensible Data (BED) file format."""
def __init__(self, target, bedN=12):
"""Create an AlignmentWriter object.
Arguments:
- target - output stream or file name
- bedN - number of columns in the BED file.
This must be between 3 and 12; default value is 12.
"""
if bedN < 3 or bedN > 12:
raise ValueError("bedN must be between 3 and 12")
super().__init__(target)
self.bedN = bedN
def format_alignment(self, alignment):
"""Return a string with one alignment formatted as a BED line."""
if not isinstance(alignment, Alignment):
raise TypeError("Expected an Alignment object")
coordinates = alignment.coordinates
if not coordinates.size: # alignment consists of gaps only
return ""
bedN = self.bedN
target, query = alignment.sequences
try:
chrom = target.id
except AttributeError:
chrom = "target"
else:
if chrom is None:
chrom = "target"
assert coordinates[0, 0] < coordinates[0, -1]
if coordinates[1, 0] > coordinates[1, -1]:
# DNA/RNA mapped to reverse strand of DNA/RNA
strand = "-"
else:
# mapped to forward strand
strand = "+"
# variable names follow those in the BED file format specification
blockSizes = []
blockStarts = []
tStart, qStart = coordinates[:, 0]
for tEnd, qEnd in coordinates[:, 1:].transpose():
if tStart == tEnd:
qStart = qEnd
elif qStart == qEnd:
tStart = tEnd
else:
blockSize = tEnd - tStart
blockStarts.append(tStart)
blockSizes.append(blockSize)
tStart = tEnd
qStart = qEnd
chromStart = blockStarts[0] # start of alignment in target
chromEnd = blockStarts[-1] + blockSize # end of alignment in target
fields = [chrom, str(chromStart), str(chromEnd)]
if bedN == 3:
return "\t".join(fields) + "\n"
try:
name = query.id
except AttributeError:
name = "query"
else:
if name is None:
name = "query"
fields.append(name)
if bedN == 4:
return "\t".join(fields) + "\n"
try:
score = alignment.score
except AttributeError:
score = 0
fields.append(str(score))
if bedN == 5:
return "\t".join(fields) + "\n"
fields.append(strand)
if bedN == 6:
return "\t".join(fields) + "\n"
try:
thickStart = alignment.thickStart
except AttributeError:
thickStart = chromStart
fields.append(str(thickStart))
if bedN == 7:
return "\t".join(fields) + "\n"
try:
thickEnd = alignment.thickEnd
except AttributeError:
thickEnd = chromEnd
fields.append(str(thickEnd))
if bedN == 8:
return "\t".join(fields) + "\n"
try:
itemRgb = alignment.itemRgb
except AttributeError:
itemRgb = "0"
fields.append(str(itemRgb))
if bedN == 9:
return "\t".join(fields) + "\n"
blockCount = len(blockSizes)
fields.append(str(blockCount))
if bedN == 10:
return "\t".join(fields) + "\n"
fields.append(",".join(map(str, blockSizes)) + ",")
if bedN == 11:
return "\t".join(fields) + "\n"
blockStarts -= chromStart
fields.append(",".join(map(str, blockStarts)) + ",")
return "\t".join(fields) + "\n"
class AlignmentIterator(interfaces.AlignmentIterator):
"""Alignment iterator for Browser Extensible Data (BED) files.
Each line in the file contains one pairwise alignment, which are loaded
and returned incrementally. Additional alignment information is stored as
attributes of each alignment.
"""
fmt = "BED"
def _read_next_alignment(self, stream):
try:
line = next(stream)
except StopIteration:
return None
words = line.split()
bedN = len(words)
if bedN < 3 or bedN > 12:
raise ValueError("expected between 3 and 12 columns, found %d" % bedN)
chrom = words[0]
chromStart = int(words[1])
chromEnd = int(words[2])
if bedN > 3:
name = words[3]
else:
name = None
if bedN > 5:
strand = words[5]
else:
strand = "+"
if bedN > 9:
blockCount = int(words[9])
blockSizes = [
int(blockSize) for blockSize in words[10].rstrip(",").split(",")
]
blockStarts = [
int(blockStart) for blockStart in words[11].rstrip(",").split(",")
]
if len(blockSizes) != blockCount:
raise ValueError(
"Inconsistent number of block sizes (%d found, expected %d)"
% (len(blockSizes), blockCount)
)
if len(blockStarts) != blockCount:
raise ValueError(
"Inconsistent number of block start positions (%d found, expected %d)"
% (len(blockStarts), blockCount)
)
blockSizes = numpy.array(blockSizes)
blockStarts = numpy.array(blockStarts)
tPosition = 0
qPosition = 0
coordinates = [[tPosition, qPosition]]
for blockSize, blockStart in zip(blockSizes, blockStarts):
if blockStart != tPosition:
coordinates.append([blockStart, qPosition])
tPosition = blockStart
tPosition += blockSize
qPosition += blockSize
coordinates.append([tPosition, qPosition])
coordinates = numpy.array(coordinates).transpose()
qSize = sum(blockSizes)
else:
blockSize = chromEnd - chromStart
coordinates = numpy.array([[0, blockSize], [0, blockSize]])
qSize = blockSize
coordinates[0, :] += chromStart
query_sequence = Seq(None, length=qSize)
query_record = SeqRecord(query_sequence, id=name, description="")
target_sequence = Seq(None, length=sys.maxsize)
target_record = SeqRecord(target_sequence, id=chrom, description="")
records = [target_record, query_record]
if strand == "-":
coordinates[1, :] = qSize - coordinates[1, :]
if chromStart != coordinates[0, 0]:
raise ValueError(
"Inconsistent chromStart found (%d, expected %d)"
% (chromStart, coordinates[0, 0])
)
if chromEnd != coordinates[0, -1]:
raise ValueError(
"Inconsistent chromEnd found (%d, expected %d)"
% (chromEnd, coordinates[0, -1])
)
alignment = Alignment(records, coordinates)
if bedN <= 4:
return alignment
score = words[4]
try:
score = float(score)
except ValueError:
pass
else:
if score.is_integer():
score = int(score)
alignment.score = score
if bedN <= 6:
return alignment
alignment.thickStart = int(words[6])
if bedN <= 7:
return alignment
alignment.thickEnd = int(words[7])
if bedN <= 8:
return alignment
alignment.itemRgb = words[8]
return alignment
|