Brick_get_matrix_mcols {HiCBricks} | R Documentation

## Get the matrix metadata columns in the Brick store.

### Description

`Brick_get_matrix_mcols` will get the specified matrix metadata column.

### Usage

    Brick_get_matrix_mcols(Brick = NULL, chr1 = NULL, chr2 = NULL,
        what = 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
`what` | Required A character vector of length 1 specifying the matrix metric to retrieve

### Value

Returns a 1xN dimensional vector containing the specified matrix metric

### Examples

    Brick.file <- system.file("extdata", "test.hdf", package = "HiCBricks")
    Brick_get_matrix_mcols(Brick = Brick.file, chr1 = "chr19", chr2 = "chr19",
    what = "bin.coverage")

[Package HiCBricks version 1.0.0 Index]