RLSeq: RLSeq

In Bishop-Laboratory/RLSeq: RLSeq: An analysis package for R-loop mapping data

RLSeq

Description

Executes the RLSeq analysis workflow.

Usage

RLSeq(object, quiet = FALSE, skip = NULL, ...)

Arguments

object	An RLRanges object.
quiet	If TRUE, messages are suppressed. Default: FALSE.
skip	Analysis steps to skip. Default: NULL. See details for options.
...	Arguments passed to analyzeRLFS.

Details

The RLSeq() function does all of the following by default:

1. RLFS Perm Test. Runs the analyzeRLFS function to test the enrichment of user-supplied ranges within R-loop-forming sequences. Cannot be skipped.

2. Predict Condition. Runs the predictCondition function to predict whether the user-supplied sample robustly maps R-loops or not. Cannot be skipped.

3. Noise analysis. Runs the noiseAnalyze function to analyze the signal-noise distribution within the supplied dataset. Skip with skip="noiseAnalyze".

4. Feature enrichment test. Runs the featureEnrich function to test the enrichment of user-supplied ranges within R-loop-relevant genomic features. Skip with skip="featureEnrich".

5. Transcript Feature Overlap. Runs the txFeatureOverlap function to get the overlap of transcript features and user-supplied peaks.

6. Correlation Analysis. Runs the corrAnalyze function to test the correlation of user-supplied R-loop signal with other samples in RLBase around "gold-standard" R-loop regions. Skip with skip="corrAnalyze".

7. Gene annotation. Runs the geneAnnotation function to find overlap of genes with the user-supplied ranges. Skip with skip="geneAnnotation".

8. R-loop Region Analysis. Runs the rlRegionTest function to find the overlap of user-supplied ranges with consensus R-loop sites (RL-Regions). Skip with skip="rlRegionTest".

Value

An RLRanges object with results available (see rlresult).

Examples

# Example RLRanges
rlr <- readRDS(system.file("extdata", "rlrsmall.rds", package = "RLSeq"))

# Run RLSeq
# `useMask=FALSE`, `ntime=10`, and `skip=` for demonstration purposes here.
rlr <- RLSeq(
    rlr,
    useMask = FALSE, ntimes = 10,
    skip = c(
        "featureEnrich", "corrAnalyze", "geneAnnotation", "rlRegionTest"
    )
)

Bishop-Laboratory/RLSeq documentation built on Jan. 28, 2023, 11:38 p.m.