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

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

Description

BrickContainer_change_experiment_name changes the location of name of the experiment

Usage

BrickContainer_change_experiment_name(Brick = NULL, experiment_name = NULL)

Arguments

Brick	Required. A string specifying the path to the BrickContainer created using Create_many_Bricks or Load_BrickContainer
experiment_name	Required. Default NULL A string specifying the new experiment name

Value

An object of class BrickContainer where the experiment_name has been changed

Examples

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

out_dir <- file.path(tempdir(), "BrickContainer_expt_name_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_experiment_name(Brick = My_BrickContainer, 
experiment_name = "I change my mind")

HiCBricks documentation built on Nov. 8, 2020, 7:45 p.m.