getBandMatrix: Get Band Matrix

Description Usage Arguments Details Value See Also Examples

View source: R/contactGroup_utils.R

Description

Get band matrix from ContactGroup.

Usage

1
getBandMatrix(cg, band.no=1)

Arguments

cg

A ContactGroup object.

band.no

Integer specifying which matrix band. band.no = 1 retrieves the main diagonal.

Details

A band matrix is a matrix whose columns are the band.no-th off-diagonal of each sample's contact matrix. If there are k samples and matrix band band.no has r entries, then the returned band matrix is of dimension r x k.

Value

A matrix with one column per sample in the ContactGroup and number of rows equal to the length of the matrix band.

See Also

ContactGroup, getBandIdx, band

Examples

1
2

bnbc documentation built on Nov. 8, 2020, 8:15 p.m.