SangerContig-class-generateReportSC {sangeranalyseR} | R Documentation

## generateReportSC

### Description

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

### Usage

    ## S4 method for signature 'SangerContig'
    generateReportSC(object, outputDir,
      includeSangerRead = TRUE, navigationAlignmentFN = NULL)

### 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`.
`navigationAlignmentFN` | The internal parameter passed to HTML report. Users should not modify this parameter on their own.

### 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]