maskFromBSGenome {regioneR} | R Documentation

## maskFromBSGenome

### Description

Extracts the merge of all the active masks from a `BSgenome`

### Usage

    maskFromBSGenome(bsgenome)

### Arguments

`bsgenome` | a `BSgenome` object

### Value

A `GRanges` object with the active mask in the `BSgenome`

### Note

This function is memoised (cached) using the `memoise` package. To empty the cache, use `forget(maskFromBSGenome)`

### See Also

`getGenomeAndMask`, `characterToBSGenome`, `emptyCacheRegioneR`

### Examples

    g <- characterToBSGenome("hg19")

    maskFromBSGenome(g)

[Package regioneR version 1.20.1 Index]