qaReport: Create HTML report using one or several QA process...

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/qaReport.R

Description

This function combines all graphical output of multiple QA process functions for one flowSet in a single hyperlinked HTML document.

Usage

1
2
qaReport(set, qaFunctions, outdir = "./qaReport",
         argLists, grouping = NULL, ...)

Arguments

set

A flowSet

qaFunctions

A character vector of the names of QA process functions to be used

outdir

The directory to which the HTML report is to be saved.

argLists

lists of argument lists for each of the QA process functions specified via qaFunctions

grouping

A character scalar indicating a variable in the flowSet's phenoData that is used as a grouping factor in the output.

...

Further arguments that are passed on to writeQAReport.

Details

This is a simple convenience function to produce HTML QA reports for a single flowSet given a list of QA process functions. For more fine-grained control use function writeQAReport directly.

An entry point to the output of this function can be found at outdir/index.html.

Value

The function is called for it's side effects

Author(s)

Florian Hahne

See Also

qaProcess.marginevents, writeQAReport, qaProcess, qaProcess.timeline

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
data(GvHD)
GvHD <- transform(GvHD, "FL1-H"=asinh(`FL1-H`), "FL2-H"=asinh(`FL2-H`))
dest <- tempdir()
qaReport(GvHD, c("qaProcess.timeline", "qaProcess.marginevents"), dest,
 list(list(channel="FL1-H", cutoff=1), list(channels=c("FL1-H",
  "FL2-H"), cFactor=4)))
browseURL(file.path(dest, "index.html"))

## End(Not run)

flowQ documentation built on Nov. 1, 2018, 3:38 a.m.