report: RLSeq Report

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

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",
  intermediates_dir = NULL,
  quiet = FALSE,
  ...
)

Arguments

object	An RLRanges object.
reportPath	A path indicating the report output HTML file. Default: "rlreport.html"
intermediates_dir	A directory indicating where intermediate files should be stored during report building. If not set, a random directory in tmp/ will be used. Default: NULL.
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)

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