generateReportSC {sangeranalyseR}R Documentation

Method generateReportSC

Description

Method generateReportSC

Usage

generateReportSC(object, outputDir = NULL, includeSangerRead = TRUE,
  ...)

Arguments

object

A SangerContig S4 instance.

outputDir

The output directory of the generated HTML report.

includeSangerRead

The parameter that decides whether to include SangerRead level report. The value is TRUE or FALSE and the default is TRUE.

...

Further generateReportSC-related parameters.

Value

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

Examples

data(sangerContigData)
## Not run: 
generateReportSC(sangerContigData)
## End(Not run)

[Package sangeranalyseR version 1.2.0 Index]