rlresult {RLSeq} | R Documentation

## RLSeq Results

### Description

Functions for creating and accessing the R-loop results (RL Results). These are a type of object used for holding the results of the tests implemented in RLSeq. They can be accessed using the `rlresult` function.

### Usage

    rlresult(object, resultName)

### Arguments

`object` | RLRanges object.
`resultName` | Name of the result slot to access. See details.

### Details

#### Slot descriptions

- `featureEnrichment`

  - The `tbl` generated from running featureEnrich.

  - The structure and column descriptions are provided in detail within RLHub::feat_enrich_samples.

- `correlationMat`

  - The `matrix` generated from running corrAnalyze.

  - Contains pairwise pearson correlations between all samples in RLBase and the supplied RLRanges object.

- `rlfsRes`

  - The `list` generated from running analyzeRLFS.

  - See analyzeRLFS for description of structure.

- `geneAnnoRes`

  - The `tbl` generated from running geneAnnotation.

- `predictRes`

  - The `list` generated from running predictCondition.

- `rlRegionRes`

  - The `list` generated from running rlRegionTest.

### Value

The contents of the requested slot.

### Examples

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

    rlresult(rlr, "predictRes")

[Package RLSeq version 1.0.0 Index]