Brick_matrix_maxdist {HiCBricks} | R Documentation

## Get the maximum loaded distance from the diagonal of any matrix.

### Description

If values beyond a certain distance were not loaded in the matrix, this distance parameter is useful. This package by default will check this param to make sure that it is not returning non-existent data.

### Usage

    Brick_matrix_maxdist(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

### Details

`Brick_matrix_maxdist` will return this parameter.

### Value

Returns an integer vector of length 1, specifying the maximum distance loaded for that matrix

### Examples

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

[Package HiCBricks version 1.0.0 Index]