Brick_list_ranges_mcols: Find out what metadata columns are associated to a ranges...

In koustav-pal/HiCBricks: Framework for Storing and Accessing Hi-C Data Through HDF Files

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, resolution = NA)

Arguments

Brick	Required. A string specifying the path to the Brick store created with Create_many_Brick.
rangekey	Optional. A string specifying the name of the ranges. If not present, the metadata columns of all ranges will be listed.
resolution	Optional. Default NA When an object of class BrickContainer is provided, resolution defines the resolution on which the function is executed

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

Bintable.path <- system.file(file.path("extdata", "Bintable_100kb.bins"), 
package = "HiCBricks")

out_dir <- file.path(tempdir(), "list_ranges_mcols_test")

dir.create(out_dir)

My_BrickContainer <- Create_many_Bricks(BinTable = Bintable.path, 
    bin_delim = " ", output_directory = out_dir, file_prefix = "Test",
    experiment_name = "Vignette Test", resolution = 100000,
    remove_existing = TRUE)

Brick_list_ranges_mcols(Brick = My_BrickContainer, rangekey = "Bintable",
resolution = 100000)

koustav-pal/HiCBricks documentation built on Oct. 25, 2022, 12:06 a.m.