Brick_list_rangekeys {HiCBricks} | R Documentation

## List the ranges tables stored within the Brick.

### Description

`Brick_list_rangekeys` lists the names of all ranges associated to a Brick.

### Usage

    Brick_list_rangekeys(Brick, resolution = NA, all_resolutions = FALSE)

### Arguments

`Brick` | Required. A string specifying the path to the Brick store created with Create_many_Brick.
`resolution` | Optional. Default NA When an object of class BrickContainer is provided, resolution defines the resolution on which the function is executed
`all_resolutions` | Optional. Default FALSE If resolution is not defined and all_resolutions is TRUE, the resolution parameter will be ignored and the function is executed on all files listed in the Brick container

### Value

A one dimensional character vector of length x specifying the names of all ranges currently present in the file.

### Examples

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

    out_dir <- file.path(tempdir(), "list_rangekeys_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_rangekeys(Brick = My_BrickContainer, resolution = 100000)

[Package HiCBricks version 1.6.0 Index]