Brick_list_ranges_mcols {HiCBricks}R Documentation

Find out what metadata columns are associated to a ranges with a certain name

Description

Brick_list_ranges_mcols will list the metadata columns of the specified ranges if it is present in the Brick store.

Usage

Brick_list_ranges_mcols(Brick, rangekey = NULL)

Arguments

Brick

Required. A string specifying the path to the Brick store created with CreateBrick.

rangekey

Optional. A string specifying the name of the ranges. If not present, the metadata columns of all ranges will be listed.

Value

if no metadata columns are present, NA. If metadata columns are present, a data.frame object containing the name of the ranges and the associated metadata column name.

Examples

Brick.file <- system.file("extdata", "test.hdf", package = "HiCBricks")
Brick_list_ranges_mcols(Brick = Brick.file, rangekey = "test_ranges")


[Package HiCBricks version 1.2.0 Index]