Brick_get_vector_values {HiCBricks} | R Documentation

## Return a N dimensional vector selection.

### Description

`Brick_get_vector_values` is the base function being used by all other matrix retrieval functions.

### Usage

    Brick_get_vector_values(Brick = NULL, chr1 = NULL, chr2 = NULL,
        xaxis = NULL, yaxis = NULL, FUN = NULL, force = FALSE)

### 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
`xaxis` | Required. A 1 dimensional vector containing the rows to retrieve. Gaps in this vector may result in unexpected behaviour as the values which are considered are min(xaxis) and max(xaxis) for retrieval.
`yaxis` | Required. A 1 dimensional vector containing the columns to retrieve. Gaps in this vector may result in unexpected behaviour as the values which are considered are min(yaxis) and max(yaxis) for retrieval.
`FUN` | Optional. Default NULL If provided a data transformation with FUN will be applied before the vector is returned.
`force` | Optional. Default FALSE If true, will force the retrieval operation when matrix contains loaded data until a certain distance.

### Value

Returns a vector of length yaxis if length of xaxis is 1. Else returns a matrix of dimension xaxis length by yaxis length.

### Note

Whatever the length of xaxis or yaxis may be, the coordinates under consideration will range from min(xaxis) to max(xaxis) on the rows or min(yaxis) to max(yaxis) on the columns.

### Examples

    Brick.file <- system.file("extdata", "test.hdf", package = "HiCBricks")
    Brick_get_vector_values(Brick = Brick.file, chr1 = "chr19",
    chr2 = "chr19", xaxis = c(1:10), yaxis = c(1:10))

[Package HiCBricks version 1.0.0 Index]