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 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
|
// Tabix queries for go
package bix
import (
"bufio"
"bytes"
"compress/gzip"
"io"
"log"
"os"
"strconv"
"strings"
"time"
"unsafe"
"github.com/biogo/hts/bgzf"
"github.com/biogo/hts/bgzf/index"
"github.com/biogo/hts/tabix"
"github.com/brentp/irelate/interfaces"
"github.com/brentp/irelate/parsers"
"github.com/brentp/vcfgo"
"github.com/pkg/errors"
)
// Bix provides read access to tabix files.
type Bix struct {
Index
bgzf *bgzf.Reader
path string
workers int
VReader *vcfgo.Reader
// index for 'ref' and 'alt' columns if they were present.
refalt []int
file *os.File
buf *bufio.Reader
}
func (tbx *Bix) init() error {
if tbx.file != nil {
return nil
}
var err error
tbx.file, err = os.Open(tbx.path)
if err != nil {
return errors.Wrapf(err, "bix: error (re)opening %s", tbx.path)
}
tbx.bgzf, err = bgzf.NewReader(tbx.file, tbx.workers)
if err != nil {
return errors.Wrapf(err, "bix: error creating new bgzf reader for %v", tbx.path)
}
return nil
}
// create a new bix that does as little as possible from the old bix
func newShort(old *Bix) (*Bix, error) {
tbx := &Bix{
Index: old.Index,
path: old.path,
workers: old.workers,
VReader: old.VReader,
refalt: old.refalt,
}
var err error
tbx.file, err = os.Open(tbx.path)
if err != nil {
return nil, errors.Wrapf(err, "bix: error (re)opening %s", tbx.path)
}
tbx.bgzf, err = bgzf.NewReader(tbx.file, old.workers)
if err != nil {
return nil, errors.Wrapf(err, "bix: error creating new bgzf reader for %v", tbx.path)
}
return tbx, nil
}
func exists(path string) bool {
_, err := os.Stat(path)
return err == nil
}
func getModTime(path string) time.Time {
if t, err := os.Stat(path); err != nil {
// ignore the error because we know the file exists from check below.
return time.Time{}
} else {
return t.ModTime()
}
}
// New returns a &Bix
func New(path string, workers ...int) (*Bix, error) {
var idx Index
var ext string
if exists(path + ".csi") {
ext = ".csi"
} else {
ext = ".tbi"
}
if getModTime(path).After(getModTime(path + ext)) {
log.Printf("warning: data file %s is modified more recently than its index.", path)
}
f, err := os.Open(path + ext)
if err != nil {
return nil, errors.Wrapf(err, "bix: error on opening %s%s", path, ext)
}
defer f.Close()
gz, err := gzip.NewReader(f)
if err != nil {
return nil, errors.Wrapf(err, "bix: error on reading tabix index: %s%s", path, ext)
}
defer gz.Close()
if ext == ".tbi" {
t, err := tabix.ReadFrom(gz)
if err != nil {
return nil, errors.Wrapf(err, "bix: error parsing tabix index from: %s.tbi", path)
}
idx = tIndex{t}
} else {
idx, err = NewCSI(gz)
if err != nil {
return nil, errors.Wrapf(err, "bix: error parsing tabix index from: %s.csi", path)
}
}
n := 1
if len(workers) > 0 {
n = workers[0]
}
b, err := os.Open(path)
if err != nil {
return nil, err
}
bgz, err := bgzf.NewReader(b, n)
if err != nil {
return nil, errors.Wrapf(err, "bix: error opening bgzf reader for %s", path)
}
var h []string
tbx := &Bix{bgzf: bgz, path: path, file: b, workers: n}
buf := bufio.NewReader(bgz)
l, err := buf.ReadString('\n')
if err != nil {
return tbx, errors.Wrapf(err, "bix: error reading line from %s", path)
}
for i := 0; i < int(idx.Skip()) || rune(l[0]) == idx.MetaChar(); i++ {
h = append(h, l)
l, err = buf.ReadString('\n')
if err != nil {
return tbx, errors.Wrapf(err, "bix: error reading line from %s", path)
}
}
header := strings.Join(h, "")
if len(h) > 0 && (strings.HasSuffix(tbx.path, ".vcf.gz") || strings.HasSuffix(tbx.path, ".vcf.bgz")) {
var err error
h := strings.NewReader(header)
tbx.VReader, err = vcfgo.NewReader(h, true)
if err != nil {
return nil, err
}
} else if len(h) > 0 {
htab := strings.Split(strings.TrimSpace(h[len(h)-1]), "\t")
// try to find ref and alternate columns to make an IREFALT
for i, hdr := range htab {
if l := strings.ToLower(hdr); l == "ref" || l == "reference" {
tbx.refalt = append(tbx.refalt, i)
break
}
}
for i, hdr := range htab {
if l := strings.ToLower(hdr); l == "alt" || l == "alternate" {
tbx.refalt = append(tbx.refalt, i)
break
}
}
if len(tbx.refalt) != 2 {
tbx.refalt = nil
}
}
tbx.buf = buf
tbx.Index = idx
return tbx, nil
}
func (b *Bix) Close() error {
b.bgzf.Close()
b.file.Close()
return nil
}
func (tbx *Bix) toPosition(toks [][]byte) interfaces.Relatable {
isVCF := tbx.VReader != nil
var g *parsers.Interval
if isVCF {
v := tbx.VReader.Parse(toks)
return interfaces.AsRelatable(v)
} else {
g, _ = newgeneric(toks, tbx.Index.NameColumn()-1, tbx.Index.BeginColumn()-1,
tbx.Index.EndColumn()-1, tbx.Index.ZeroBased())
}
if tbx.refalt != nil {
ra := parsers.RefAltInterval{Interval: *g, HasEnd: tbx.Index.EndColumn() != tbx.Index.BeginColumn()}
ra.SetRefAlt(tbx.refalt)
return &ra
}
return g
}
func unsafeString(b []byte) string {
return *(*string)(unsafe.Pointer(&b))
}
// return an interval using the info from the tabix index
func newgeneric(fields [][]byte, chromCol int, startCol int, endCol int, zeroBased bool) (*parsers.Interval, error) {
s, err := strconv.Atoi(unsafeString(fields[startCol]))
if err != nil {
return nil, err
}
if !zeroBased {
s -= 1
}
e, err := strconv.Atoi(unsafeString(fields[endCol]))
if err != nil {
return nil, err
}
return parsers.NewInterval(string(fields[chromCol]), uint32(s), uint32(e), fields, uint32(0), nil), nil
}
func (tbx *Bix) ChunkedReader(chrom string, start, end int) (io.ReadCloser, error) {
chunks, err := tbx.Chunks(chrom, start, end)
if err == index.ErrNoReference {
if strings.HasPrefix(chrom, "chr") {
chunks, err = tbx.Chunks(chrom[3:], start, end)
} else {
chunks, err = tbx.Chunks("chr"+chrom, start, end)
}
}
if err == index.ErrInvalid {
return index.NewChunkReader(tbx.bgzf, []bgzf.Chunk{})
} else if err == index.ErrNoReference {
log.Printf("chromosome %s not found in %s\n", chrom, tbx.path)
return index.NewChunkReader(tbx.bgzf, []bgzf.Chunk{})
} else if err != nil {
return nil, errors.Wrapf(err, "bix: error reading Chunks from %s", tbx.path)
}
cr, err := index.NewChunkReader(tbx.bgzf, chunks)
if err != nil {
return nil, errors.Wrapf(err, "bix: error creating chunked reader from %s", tbx.path)
}
return cr, nil
}
// bixerator meets interfaces.RelatableIterator
type bixerator struct {
rdr io.ReadCloser
buf *bufio.Reader
tbx *Bix
region interfaces.IPosition
}
func makeFields(line []byte) [][]byte {
fields := make([][]byte, 9)
copy(fields[:8], bytes.SplitN(line, []byte{'\t'}, 8))
s := 0
for i, f := range fields {
if i == 7 {
break
}
s += len(f) + 1
}
/*
if s >= len(line) {
c := make([]string, len(fields))
for k, f := range fields {
c[k] = string(f)
}
log.Println(s, string(line), c)
}
*/
e := bytes.IndexByte(line[s:], '\t')
if e == -1 {
e = len(line)
} else {
e += s
}
fields[7] = line[s:e]
if len(line) > e+1 {
fields[8] = line[e+1:]
} else {
fields = fields[:8]
}
return fields
}
func (b bixerator) Next() (interfaces.Relatable, error) {
for {
line, err := b.buf.ReadBytes('\n')
if err == io.EOF && len(line) == 0 {
return nil, io.EOF
} else if err != nil {
return nil, errors.Wrapf(err, "bix: error iterating on %s", b.tbx.path)
}
if len(line) == 0 {
return nil, io.EOF
}
if line[len(line)-1] == '\n' {
line = line[:len(line)-1]
}
in := true
var toks [][]byte
if b.region != nil {
var err error
in, err, toks = b.inBounds(line)
if err != nil {
return nil, err
}
} else {
if b.tbx.VReader != nil {
toks = makeFields(line)
} else {
toks = bytes.Split(line, []byte{'\t'})
}
}
if in {
return b.tbx.toPosition(toks), nil
}
}
return nil, io.EOF
}
func (b bixerator) Close() error {
if b.rdr != nil {
b.rdr.Close()
}
return b.tbx.Close()
}
var _ interfaces.RelatableIterator = bixerator{}
// FastQuery allows extracting intervals from an indexed file. Use this function if
// concurrency is *not* required, otherwise use Query
func (tbx *Bix) FastQuery(region interfaces.IPosition) (interfaces.RelatableIterator, error) {
if err := tbx.init(); err != nil {
return nil, err
}
cr, err := tbx.ChunkedReader(region.Chrom(), int(region.Start()), int(region.End()))
if err != nil {
if cr != nil {
cr.Close()
tbx.Close()
}
return nil, err
}
return bixerator{cr, bufio.NewReader(cr), tbx, region}, nil
}
// Query allows extracting intervals from an indexed file. Use this function if
// concurrency is required, otherwise use FastQuery
func (tbx *Bix) Query(region interfaces.IPosition) (interfaces.RelatableIterator, error) {
tbx2, err := newShort(tbx)
if err != nil {
return nil, err
}
if region == nil {
var l string
var err error
buf := bufio.NewReader(tbx2.bgzf)
l, err = buf.ReadString('\n')
for i := 0; i < tbx2.Index.Skip() || rune(l[0]) == tbx2.Index.MetaChar(); i++ {
l, err = buf.ReadString('\n')
if err != nil {
return nil, err
}
}
if tbx2.Index.Skip() == 0 && rune(l[0]) != tbx2.Index.MetaChar() {
buf = bufio.NewReader(io.MultiReader(strings.NewReader(l), buf))
}
return bixerator{nil, buf, tbx2, region}, nil
}
cr, err := tbx2.ChunkedReader(region.Chrom(), int(region.Start()), int(region.End()))
if err != nil {
if cr != nil {
cr.Close()
tbx2.Close()
}
return nil, err
}
return bixerator{cr, bufio.NewReader(cr), tbx2, region}, nil
}
func (tbx *Bix) AddInfoToHeader(id, number, vtype, desc string) {
if tbx.VReader == nil {
return
}
tbx.VReader.AddInfoToHeader(id, number, vtype, desc)
}
func (tbx *Bix) GetHeaderType(field string) string {
if tbx.VReader == nil {
return ""
}
return tbx.VReader.GetHeaderType(field)
}
func (tbx *Bix) GetHeaderDescription(field string) string {
if tbx.VReader == nil {
return ""
}
if h, ok := tbx.VReader.Header.Infos[field]; ok {
return h.Description
}
return ""
}
func (tbx *Bix) GetHeaderNumber(field string) string {
if tbx.VReader == nil {
return "1"
}
if h, ok := tbx.VReader.Header.Infos[field]; ok {
return h.Number
}
return "1"
}
func (b *bixerator) inBounds(line []byte) (bool, error, [][]byte) {
var readErr error
line = bytes.TrimRight(line, "\r\n")
var toks [][]byte
if b.tbx.VReader != nil {
toks = makeFields(line)
} else {
toks = bytes.Split(line, []byte{'\t'})
}
s, err := strconv.Atoi(unsafeString(toks[b.tbx.BeginColumn()-1]))
if err != nil {
return false, err, toks
}
pos := s
if !b.tbx.ZeroBased() {
pos -= 1
}
if pos >= int(b.region.End()) {
return false, io.EOF, toks
}
if b.tbx.EndColumn() != 0 {
e, err := strconv.Atoi(unsafeString(toks[b.tbx.EndColumn()-1]))
if err != nil {
return false, err, toks
}
if e < int(b.region.Start()) {
return false, readErr, toks
}
return true, readErr, toks
} else if b.tbx.VReader != nil {
start := int(b.region.Start())
alt := strings.Split(string(toks[4]), ",")
lref := len(toks[3])
if start >= pos+lref {
for _, a := range alt {
if a[0] != '<' || a == "<CN0>" {
e := pos + lref
if e > start {
return true, readErr, toks
}
} else if strings.HasPrefix(a, "<DEL") || strings.HasPrefix(a, "<DUP") || strings.HasPrefix(a, "<INV") || strings.HasPrefix(a, "<CN") {
info := string(toks[7])
e, err := extractEndValue(info)
if err != nil {
log.Println("no end:", b.tbx.path, string(toks[0]), pos, string(toks[3]), a)
} else {
if e > start {
return true, readErr, toks
}
return false, readErr, toks
}
}
}
} else {
return true, readErr, toks
}
return false, readErr, toks
}
return false, readErr, toks
}
// extractEndValue extracts the END value from a VCF INFO field string.
// It handles cases where END= is at the beginning, middle, or end of the INFO field.
// Returns the END value as an integer and any parsing error.
func extractEndValue(info string) (int, error) {
var idx int
// Look for ;END= first (most common case)
if idx = strings.Index(info, ";END="); idx == -1 {
// Check if END= is at the beginning of the INFO field
if strings.HasPrefix(info, "END=") {
idx = 0
} else {
return 0, errors.New("END field not found")
}
}
// Skip past "END=" (idx points to either ';' or start of string)
var start int
if idx > 0 {
start = idx + 5 // skip ";END="
} else {
start = 4 // skip "END="
}
// Find the end of the END value (next semicolon or end of string)
end := strings.Index(info[start:], ";")
var endValue string
if end == -1 {
// END is the last field, take everything to the end
endValue = info[start:]
} else {
// END is followed by more fields
endValue = info[start : start+end]
}
return strconv.Atoi(endValue)
}
|