characterToBSGenome {regioneR} | R Documentation

## characterToBSGenome

### Description

Given a character string with the "name" of a genome, it returns a `BSgenome` object if available.

### Usage

    characterToBSGenome(genome.name)

### Arguments

`genome.name` | a character string uniquely identifying a `BSgenome` (e.g. "hg19", "mm10" are ok, but "hg" is not)

### Value

A `BSgenome` object

### Note

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

### See Also

`getGenomeAndMask`, `maskFromBSGenome`

### Examples

    g <- characterToBSGenome("hg19")

[Package regioneR version 1.20.1 Index]