BrickContainer_list_chromosomes: Return the descriptive name of the BrickContainer

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

Return the descriptive name of the BrickContainer

Description

BrickContainer_list_chromosomes returns the chromosomes available in the BrickContainer

Usage

BrickContainer_list_chromosomes(Brick = NULL, lengths = FALSE)

Arguments

Brick	Required. A string specifying the path to the Brick store created with Create_many_Bricks.
lengths	Default FALSE If TRUE, will also return the chromosomal lengths

Value

If lengths is FALSE, only the chromosome names are returned. If lengths is TRUE, a data.frame containing the chromosome names and their lengths is provided.

Examples

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

out_dir <- file.path(tempdir(), "BrickContainer_list_chromosome_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)

BrickContainer_list_chromosomes(My_BrickContainer)

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