plotRLRegionOverlap {RLSeq} | R Documentation

## Plot RL-Region overlap with RLRanges

### Description

Convenience function for plotting the overlap between RLRanges and R-loop regions (RL regions) as calculated by rlRegionTest.

### Usage

    plotRLRegionOverlap(object, returnData = FALSE, rlregions_table = NULL, ...)

### Arguments

`object` | An RLRanges object with rlRegionTest already run.
`returnData` | If TRUE, plot data is returned instead of plotting. Default: FALSE
`rlregions_table` | The table of RLRegions to overlap sample ranges with. Obtained from RLHUb using RLHub::rlregions_meta. Loaded from RLHub if not supplied. Default: NULL.
`...` | Additional arguments passed to VennDiagram::venn.diagram

### Value

A ggplot2::ggplot object containing the venn diagram. Built using ggplotify::as.ggplot.

### Examples

    # Example dataset with rlRegionTest() already run.
    rlr <- readRDS(system.file("extdata", "rlrsmall.rds", package = "RLSeq"))

    # Plot RL-Region overlap
    plotRLRegionOverlap(rlr)

    # Return data only
    plotRLRegionOverlap(rlr, returnData = TRUE)

[Package RLSeq version 1.0.0 Index]