rbamtools (version 2.1.0)

bamReader-class: Class "bamReader"

Description

A bamReader object encapulates functionality for reading of bamAligns from a BAM-file. It optionally contains a pointer to a bam-index structure which allows fast access to aligns that overlap a specified region (random access). The index is loaded via the loadIndex function.

Objects from the Class

Objects can be created by calls of the form reader<-bamReader(filename).

References

The SAM Format Specification (v1.4-r985). The SAM Format Specification Working Group. September 7, 2011. http://www.samtools.sourceforge.net/SAM1.pdf

Examples

library(rbamtools)
bam<- system.file("extdata", "accepted_hits.bam", package="rbamtools")
idx<- system.file("extdata", "accepted_hits.bam.bai", package="rbamtools")
# Open BAM-file for reading
reader<-bamReader(bam)
isOpen(reader)
# Create and load new index
idx<-"index.bam.bai"
createIndex(reader,idx)
loadIndex(reader,idx)
index.initialized(reader)
# Load package provided index
loadIndex(reader,idx)
index.initialized(reader)
# Read align
align<-getNextAlign(reader)
coords<-as.integer(c(0,0,249250621))
range<-bamRange(reader,coords)
align<-getNextAlign(range)
bamClose(reader)