generateReport {sangeranalyseR}R Documentation

Method generateReport

Description

A method which generates final reports of the SangerRead, SangerContig, and SangerAlignment instance.

Usage

generateReport(object, outputDir = NULL, includeSangerContig = TRUE,
  includeSangerRead = TRUE, ...)

Arguments

object

A SangerRead, SangerContig, or SangerAlignment S4 instance.

outputDir

The output directory of the generated HTML report.

includeSangerContig

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

includeSangerRead

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

...

Further generateReportSR, generateReportSC, and generateReportSA related parameters.

Value

A SangerRead, SangerContig, or SangerAlignment object.

Author(s)

Kuan-Hao Chao

Examples

data(sangerReadFData)
data(sangerContigData)
data(sangerAlignmentData)
## Not run: 
generateReport(sangerReadFData)
generateReport(sangerContigData)
generateReport(sangerAlignmentData)
## End(Not run)

[Package sangeranalyseR version 1.0.0 Index]