flowQ (version 1.32.0)

qaProcess.KLDistPlot: Creates a QA process for comparisons of KL Distances across multiple samples

Description

This function takes a list of flowSet as input and creates all necessary outputs for an 'KLDistPlot' type of QA process. Objects created by this function can be laid out as HTML using writeQAReport.

Usage

qaProcess.KLDistPlot(flowList,dyes=NULL,outdir="QAReport",
			alpha=0.05, absolute.value=NULL,sum.dimensions=NULL,
			det.dimensions=NULL, pdf=TRUE,
			name="KLDist",...)

Arguments

flowList

A list of flowSet

dyes

Flow parameters to be compared across multiple samples. If set to NULL, all parameters that are duplicated across the list of flowSet are identified and compared.

outdir

The directory to which the graphical output is to be saved. If multiple QA processes are to be combined, make sure to use the same directory every time.

alpha

Outlier mislabeling rate

absolute.value

If provided, the absolute.value is used for the outlier detection and the alpha argument is ignored. defualt is NULL

sum.dimensions

The dimensions of summary plot generated in inches, default is NULL where the dimensions are automatically selected

det.dimensions

the dimensions of each sub image generated by the QA process in inches, default is NULL where the dimensions are automatically selected.

pdf

boolen value determinining if pdf files or jpeg images will be produced by the QA process

name

The name of the process used for the headings in the HTML output.

...

Further arguments.

Value

An object of class qaProcess.

Details

QA processes of type 'KLDistPlot' detects differences in the pairwise KL Distances of the flow parameters across multiple samples. For more details on how to layout qaProcess objects to HTML, see writeQAReport and qaReport.

See Also

writeQAReport, qaReport, qaProcess, qaProcess.DensityPlot qaProcess.2DStatsPlot qaProcess.BoundaryPlot

Examples

data(qData)
dest <- tempdir()
resKLdist <- qaProcess.KLDistPlot(qData, dyes=c("SSC-A","FSC-A"),
               outdir=dest, alpha=0.05, pdf=TRUE)
resKLdist