readRegionSetAnnotation {LOLA}R Documentation

Given a folder containing region collections in subfolders, this function will either read the annotation file if one exists, or create a generic annotation file.

Description

Given a folder containing region collections in subfolders, this function will either read the annotation file if one exists, or create a generic annotation file.

Usage

readRegionSetAnnotation(
  dbLocation,
  collections = NULL,
  refreshCaches = FALSE,
  refreshSizes = TRUE,
  useCache = TRUE
)

Arguments

dbLocation

folder where your regionDB is stored.

collections

Restrict the database loading to this list of collections Leave NULL to load the entire database (Default).

refreshCaches

should I recreate the caches? Default: FALSE

refreshSizes

should I refresh the size files? Default:TRUE

useCache

Use simpleCache to store results and load them?

Value

Region set annotation (data.table)

Examples

dbPath = system.file("extdata", "hg19", package="LOLA")
regionAnno = readRegionSetAnnotation(dbLocation=dbPath)

[Package LOLA version 1.22.0 Index]