qaProcessFrame-class {flowQ} | R Documentation

## Class "qaProcessFrame"

### Description

Abstraction of subitems within a qQA process

### Details

This class bundles graphs and aggregators for a single `flowFrame`. This allows to create processes with subcomponents, where each item in the `frameAggregators` and `frameGraphs` lists corresponds to one subprocess, which can be used, for instance, to create individual plots for each flow channel. For QA processes without subcomponents, these slots would simply not be populated.

### Objects from the Class

Objects should be created using the constructor:

`qaProcessFrame(frameID, summaryAggregator, summaryGraph, frameAggregators, frameGraphs, details)` where `frameID` is the ID of the flowFrame the process is linked to, `summaryAggregator` is an object inheriting from class `qaAggregator` which summarizes the outcome, `summaryGraph` is an object of class `qaGraph` which is the overview graph of the process for the whole frame, `details` is a list containing any additional information regarding the QA process, `frameAggregators` is an object of class `aggregatorList` and `frameGraphs` is an object of class `qaGraphList`. The latter two are the collections of aggregators and graphs for each subprocess. Only `frameID` and `summaryAggregator` are mandatory arguments.

### Slots

`id`:
  Object of class `"character"`, a unique ID of the object
`frameID`:
  Object of class `"character"`, ID of the flowFrame the process is linked to
`summaryAggregator`:
  Object of class `"qaAggregator"`, an aggregator summarizing the output of the process
`summaryGraph`:
  Object of class `"qaGraph"`, a graphical summary of the process
`frameAggregators`:
  Object of class `"aggregatorList"` a list of aggregators for the subprocesses
`frameGraphs`:
  Object of class `"qaGraphList"` a list of graphical summaries for the subprocesses
`details`:
  A list for any additional information

### Methods

initialize
  `signature(.Object = "qaProcessFrame")`: constructor

### Author(s)

Florian Hahne

### See Also

`qaGraphList`, `writeQAReport`, `qaProcess`

### Examples

    showClass("qaProcessFrame")

[Package flowQ version 1.4.0 Index]