readBam

Description

Reads a bam file through RSamtools, and converts it into a data frame of class DataFrame

Usage

1
readBam(file_name, tags = character(0))

Arguments

file_name

Character string of bam file location

tags

Bam tags to import into the data frame. By default it only takes the standard values if none are given.

Details

This function formalizes what had been described in the RSamtools documentation and makes it easier to compute the downstream functions in this package.

Value

Returns the bam file contents in a readable dataframe format.

Author(s)

Diana H.P. Low

References

RSamtools package

Examples

1
2
bam.files <- dir(system.file("extdata", package = "ssviz"), full = TRUE, patt = "bam$")
ctrlbam <- readBam(bam.files[1])