generateReportSC-methods: Method generateReportSC

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

Method generateReportSC

Description

Method generateReportSC

Usage

generateReportSC(
  object,
  outputDir = NULL,
  includeSangerRead = TRUE,
  colors = "default",
  ...
)

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.
colors	A vector for users to set the colors of (A, T, C, G, else). There are three options for users to choose from. 1. "default": (green, blue, black, red, purple). 2. "cb_friendly": ((0, 0, 0), (199, 199, 199), (0, 114, 178), (213, 94, 0), (204, 121, 167)). 3. Users can set their own colors with a vector with five elements.
...	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)

roblanf/sangeranalyseR documentation built on April 15, 2024, 12:44 a.m.