BrickContainer_change_output_directory: Change the location of HDF files in the BrickContainer object

View source: R/BrickContainer_functions.R

BrickContainer_change_output_directoryR Documentation

Change the location of HDF files in the BrickContainer object

Description

BrickContainer_change_output_directory changes the location of associated HDF files

Usage

BrickContainer_change_output_directory(Brick = NULL, output_directory = NULL)

Arguments

Brick

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

output_directory

Required. Default NULL A string specifying new location of the output_directory. Please note, that the location of the HDF files will not be changed.

Value

An object of class BrickContainer where the output_directory has been changed

Examples

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

out_dir <- file.path(tempdir(), "BrickContainer_out_dir_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_change_output_directory(Brick = My_BrickContainer, 
output_directory = tempdir())

koustav-pal/HiCBlocks documentation built on Oct. 29, 2022, 8:17 a.m.