report {RLSeq} | R Documentation

## RLSeq Report

### Description

Builds an HTML report to showcase the results available in the supplied RLRanges object (see also RLResults).

### Usage

    report(object, reportPath = "rlreport.html", quiet = FALSE, ...)

### Arguments

`object` | An RLRanges object.
`reportPath` | A path indicating the report output HTML file. Default: "rlreport.html"
`quiet` | If TRUE, messages are suppressed. Default: FALSE.
`...` | Arguments passed to `rmarkdown::render()`

### Value

TRUE

### Examples

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

    # Get a TMP file (only for example usae)
    tmp <- tempfile()

    # Generate the report
    report(rlr, reportPath = tmp)

[Package RLSeq version 1.0.0 Index]