annotateRegions {GenomicInteractions}R Documentation

Annotate regions

Description

Use this function to add metadata parallel to the 'regions' slot of a GenomicInteractions or GInteractions object.

Usage

annotateRegions(GIObject, name, dat)

## S4 method for signature 'GInteractions,character,vector'
annotateRegions(GIObject, name, dat)

Arguments

GIObject

A GenomicInteractions or GInteractions object

name

Character. Will be used as a column name.

dat

Vector of the same length as the GInteractions object, containing data with which to annotate the object.

Value

invisible(1)

Examples

data(hic_example_data)
chip <- runif(n = length(regions(hic_example_data)), max = 1000)
annotateRegions(hic_example_data, "chip", chip)

[Package GenomicInteractions version 1.18.0 Index]