Brick_matrix_exists {HiCBricks} | R Documentation

## Check if a chromosome pair exists.

### Description

Matrices are created when the bintable is loaded and the chromosome names are provided. If a user is in doubt regarding whether a matrix is present or not it is useful to check this function. If the Bintable did not contain a particular chromosome, any matrices for that chromosome would not be present in the file

### Usage

    Brick_matrix_exists(Brick = NULL, chr1 = NULL, chr2 = NULL)

### Arguments

`Brick` | Required. A string specifying the path to the Brick store created with CreateBrick.
`chr1` | Required. A character vector of length 1 specifying the chromosome corresponding to the rows of the matrix
`chr2` | Required. A character vector of length 1 specifying the chromosome corresponding to the columns of the matrix

### Value

Returns a logical vector of length 1, specifying if the matrix exists or not.

### Examples

    Brick.file <- system.file("extdata", "test.hdf", package = "HiCBricks")
    Brick_matrix_exists(Brick = Brick.file, chr1 = "chr19", chr2 = "chr19")

    Brick.file <- system.file("extdata", "test.hdf", package = "HiCBricks")
    Brick_matrix_exists(Brick = Brick.file, chr1 = "chr19", chr2 = "chr20")

[Package HiCBricks version 1.0.0 Index]