Brick_get_ranges {HiCBricks} | R Documentation |
Brick_get_ranges
will get a ranges object if present in the Brick store
and return a GRanges object.
Brick_get_ranges(Brick, chr = NULL, rangekey)
Brick |
Required. A string specifying the path to the Brick store created with CreateBrick. |
chr |
Optional. A chr string specifying the chromosome to select from the ranges. |
rangekey |
Required. A string specifying the name of the ranges. |
If a rangekey is present, the ranges will be retrieve and a GRanges constructed. Metadata columns will also be added. If these are rangekeys other than "Bintable", and had been added using Brick_add_ranges the width and Strand columns may appear as metadata columns. These will most likely be artifacts from converting the original ranges object to a data.frame.
Returns a GRanges object with the associated metadata columns that may have been present in the Ranges object.
Brick.file <- system.file("extdata", "test.hdf", package = "HiCBricks") Brick_get_ranges(Brick = Brick.file, chr = "chr19", rangekey = "Bintable")