SingleRepReport: Final report for single group of regions

SingleRepReportR Documentation

Final report for single group of regions

Description

When user call all steps in the pipeline, the final report can be generated.

Usage

atacSingleRepReport(prevStep, htmlOutput = NULL, createHTML = TRUE, ...)

## S4 method for signature 'Step'
atacSingleRepReport(prevStep, htmlOutput = NULL, createHTML = TRUE, ...)

Arguments

prevStep

Step-class object scalar. Any steps object in this package is acceptable when the pipeline is ready.

htmlOutput

Character scalar. HTML report file directory Default: NULL ("Report.html")

createHTML

Logical scalar. If create HTML file. Default: TRUE. This parameter needs to be set FALSE when pandoc or other dependence softwares are not available for rmarkdown package.

...

Additional arguments, currently unused.

Details

The report is HTML format. All link in HTML file is the relative directory in report step folder and other step folder If user want to move HTML file and keep all link access available, they should move the whole pipeline folder at the same time.

Value

An invisible ATACProc-class object (Step-class based) scalar for downstream analysis.

Author(s)

Zheng Wei

See Also

atacPipe


wzthu/wzzw documentation built on Aug. 13, 2022, 7:11 a.m.