generate_report: CEMiTool report

generate_reportR Documentation

CEMiTool report

Description

Creates report for CEMiTool results

Usage

generate_report(cem, ...)

## S4 method for signature 'CEMiTool'
generate_report(
  cem,
  max_rows_ora = 50,
  title = "Report",
  directory = "./Reports/Report",
  force = FALSE,
  ...
)

Arguments

cem

Object of class CEMiTool.

...

parameters to rmarkdown::render

max_rows_ora

maximum number of rows in Over Representation Analysis table results

title

Character string with the title of the report.

directory

Directory name for results.

force

If the directory exists, execution will not stop.

Value

An HTML file with an interactive report of CEMiTool analyses.

Examples

## Not run:   
# Get example CEMiTool object
data(cem)
generate_report(cem, output_format=c("pdf_document", "html_document"))

## End(Not run)


csbl-usp/CEMiTool documentation built on March 27, 2024, 5:14 a.m.