io-bigwig-read: Read a BigWig file

read_bigwigR Documentation

Read a BigWig file

Description

Read a BigWig file

Usage

read_bigwig(file, genome_info = NULL, overlap_ranges = NULL)

Arguments

file

A path to a file or URL.

genome_info

An optional character string or a Ranges object that contains information about the genome build. For example the identifier "hg19" will add build information to the returned GRanges.

overlap_ranges

An optional Ranges object. Only the intervals in the file that overlap the Ranges will be loaded.

Value

a GRanges object

See Also

rtracklayer::BigWigFile()

Examples

if (.Platform$OS.type != "windows") {
  test_path <- system.file("tests", package = "rtracklayer")
  bw_file <- file.path(test_path, "test.bw")
  gr <- read_bigwig(bw_file)
  gr
}

sa-lee/plyranges documentation built on April 15, 2024, 12:25 p.m.