BrickContainer_unlink_resolution: Remove links to all Hi-C matrices for a given resolution.

View source: R/BrickContainer_functions.R

BrickContainer_unlink_resolutionR Documentation

Remove links to all Hi-C matrices for a given resolution.

Description

BrickContainer_unlink_resolution removes links to all files associated to a given resolution

Usage

BrickContainer_unlink_resolution(Brick = NULL, resolution = NULL)

Arguments

Brick

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

resolution

Required A string specifying the resolution to remove. This string must match the resolution values listed by BrickContainer_list_resolutions

Value

An object of class BrickContainer where the resolution and links to its associated files have been removed

Examples

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

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

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

BrickContainer_unlink_resolution(Brick = My_BrickContainer, 
resolution = 40000)


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