qaProcess.KLDistPlot {flowQ}R Documentation

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,det.dimensions=c(400,400),pdf=FALSE,...)

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
det.dimensions the dimensions of each image generated by the QA process.
pdf boolen value determinining if pdf files or jpeg images will be produced by the QA process
... Further arguments.

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.

Value

An object of class qaProcess.

Author(s)

Nishant Gopalakrishnan

See Also

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

Examples

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


[Package flowQ version 1.4.0 Index]