grl.unlist: Robust unlisting of 'GRangesList' that keeps track of origin

In mskilab/gUtils: R Package Providing Additional Capabilities and Speed for GenomicRanges Operations

Robust unlisting of GRangesList that keeps track of origin

Description

Robust unlisting of GRangesList that keeps track of origin

Does a "nice" unlist of a GRangesList object adding a field grl.ix denoting which element of the GRangesList each GRanges corresponds to and a field grl.iix which saves the (local) index that that gr was in its corresponding GRangesList item

In this way, grl.unlist is reversible, while BiocGenerics::unlist is not.

Usage

grl.unlist(grl, use.group = FALSE)

Arguments

grl	GRangeList object to unlist
use.group	logical force grl.unlist to use the "group" field for setting grl.ix. By default, grl.unlist would first try to use the "element", but if the input GRangesList contains a GRanges with a field that starts with the substring "element" then grl.unlist would fail.

Value

GRanges with added metadata fields grl.ix and grl.iix.

Examples

grl.unlist(grl.hiC)

mskilab/gUtils documentation built on June 15, 2025, 2:52 p.m.