compensateView-class {flowCore}R Documentation

Class "compensateView"

Description

Class and method to capture the result of compensation operations in a flow cytometry workflow.

Usage


compensateView(workflow, ID=paste("compViewRef", guid(), sep="_"),
                          name="default", action, data)

Arguments

workflow An object of class workFlow for which a view is to be created.
ID A unique identifier of the view, most likely created by using the internal guid function.
name A more human-readable name of the view.
data, action References to the data and actionItem objects, respectively.

Value

A reference to the compensateView that is created inside the workFlow environment as a side effect of calling the add method.
A compensateView object for the constructor.

Objects from the Class

Objects should be created using the add method, which creates a compensateView from a compensation object and directly assigns it to a workFlow. Alternatively, one can use the compensateView constructor function for more programmatic access.

Slots

ID:
Object of class "character". A unique identifier for the view.
name:
Object of class "character". A more human-readable name
action:
Object of class "fcActionReference". A reference to the actionItem that generated the view.
env:
Object of class "environment". The evaluation environment in the workFlow.
data:
Object of class "fcDataReference" A reference to the data that is associated to the view.

Extends

Class "view", directly.

Methods

Rm
signature(symbol = "compensateView", envir = "workFlow", subSymbol = "character"): Remove a compensateView from a workFlow. This method is recursive and will also remove all dependent views and actionItems.

Author(s)

Florian Hahne

See Also

workFlow, view, gateView, transformView, normalizeView, actionItem

Examples

showClass("view")

[Package flowCore version 1.10.0 Index]