makeRmdReport: make ezRun Rmd report
In uzh/ezRun: An R meta-package for the analysis of Next Generation Sequencing Data

makeRmdReport

R Documentation

make ezRun Rmd report

Description

Makes an ezRun Rmd report and additionally writes the R objects to disk using eather RDS or the qs2 format

Usage

makeRmdReport(
  ...,
  htmlFile = "00index.html",
  rmdFile = "",
  selfContained = TRUE,
  reportTitle = "SUSHI Report",
  use.qs2 = FALSE
)

Arguments

`...`	any number of R object
`htmlFile`	The name of the output html
`rmdFile`	The name of the Rmd template
`selfContained`	If FALSE, will copy over the css and other aesthetic assets
`reportTitle`	Title to use the header of the html
`use.qs2`	If TRUE, use qs2 rather than rds

Author(s)

Rehrauer, Hubert

Schmid, Peter

Examples

makeRmdReport(param=param, output=output, scData=scData, rmdFile = "ScSeuratCombine.Rmd", reportTitle = "Seurat Report", use.qs2=TRUE) 
# Outputs the report as '00index.html' in addition to files 'param.qs2', 'output.qs2', 'scData.qs2'

uzh/ezRun documentation built on March 5, 2025, 3:41 p.m.