README.md

In sheffien/LOLA: Locus overlap analysis for enrichment of genomic ranges

LOLA: Genomic Locus Overlap Enrichment Analysis

• Documentation.
• Release version at Bioconductor.
• GitHub repository.

LOLA is an R package providing functions for testing overlap of sets of genomic regions with public and custom databases. You can think of it as testing your bed file (genome regions of interest) against a database of other bed files (regions from various previous studies) to look for enrichment of overlaps. This enables you to draw connections between newly generated data, and the growing public databases, leading to new hypotheses and annotation sharing.

This README provides a package overview, motivation, and installation instructions. For detailed documentation of functions and additional examples, please see the R documentation.

Installing LOLA

The release version of LOLA can be installed directly from Bioconductor:

if (!requireNamespace("BiocManager", quietly=TRUE))
    install.packages("BiocManager")
BiocManager::install("LOLA")

To install the development version directly from github, make sure you have GenomicRanges (bioconductor package) installed, then install LOLA with devtools:

if (!requireNamespace("BiocManager", quietly=TRUE))
    install.packages("BiocManager")
BiocManager::install("GenomicRanges")

devtools::install_github("nsheff/LOLA")

Or, clone the repo and install from there:

install.packages("path/to/LOLA", repos=NULL)

Running LOLA

For examples and workflows for LOLA, please check out the R vignettes.

LOLA Databases

Downloads of core databases and instructions for building your own databases are at databio.org/regiondb.

sheffien/LOLA documentation built on Sept. 3, 2020, 8:29 p.m.