generateReportSA-methods: Method generateReportSA

In sangeranalyseR: sangeranalyseR: a suite of functions for the analysis of Sanger sequence data in R

Description

Method generateReportSA

Usage

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

Arguments

object	A 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 generateReportSA-related parameters.

Value

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

Examples

data(sangerAlignmentData)
## Not run: 
generateReportSA(sangerAlignmentData)
## End(Not run)

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