SangerRead-class-generateReportSR: generateReportSR

Description Usage Arguments Value Examples

Description

A SangerRead method which generates final reports of the SangerRead instance.

Usage

1
2
3
## S4 method for signature 'SangerRead'
generateReportSR(object, outputDir,
  navigationContigFN = NULL, navigationAlignmentFN = NULL)

Arguments

object

A SangerRead S4 instance.

outputDir

The output directory of the generated HTML report.

navigationContigFN

The internal parameter passed to HTML report. Users should not modify this parameter on their own.

navigationAlignmentFN

The internal parameter passed to HTML report. Users should not modify this parameter on their own.

Value

The output absolute path to the SangerRead's HTML file.

Examples

1
2
3
4
data("sangerReadFData")
## Not run: 
generateReportSR(sangerReadFData)
## End(Not run)

sangeranalyseR documentation built on Nov. 8, 2020, 5:59 p.m.