normalizeActionItem-class {flowCore} | R Documentation |
Class and method to capture normalization operations in a flow cytometry workflow.
normalizeActionItem(ID = paste("normActionRef", guid(), sep = "_"), name = paste("action", identifier(get(normalization)), sep = "_"), parentView, normalization, workflow)
workflow |
An object of class |
ID |
A unique identifier of the view, most likely created by using the
internal |
name |
A more human-readable name of the view. |
parentView, normalization |
References to the parent |
normalizeActionItems
provide a means to bind normalization operations
like warping in a workflow. Each normalizeActionItem
represents a
single normalization
.
A reference to the normalizeActionItem
that is created inside the
workFlow
environment as a side effect of calling the
add
method.
A normalizeActionItem
object for the constructor.
normalization
Object of class
"fcNormalizationReference"
. A reference to the
normalization
object that is used for the
compensation operation.
ID
Object of class "character"
. A unique
identifier for the actionItem
.
name
Object of class "character"
. A more
human-readable name.
parentView
Object of class
"fcViewReference"
. A reference to the parent
view
the normalizeActionItem
is applied on.
env
Object of class "environment"
. The
evaluation environment in the workFlow
.
Objects should be created using the add
method, which creates a
normalizeActionItem
from a normalization
object and
directly assigns it to a workFlow
. Alternatively, one can use
the normalizeActionItem
constructor function for more programmatic
access.
Class "actionItem"
, directly.
signature(x = "normalizeActionItem")
: Print
details about the object.
signature(symbol = "normalizeActionItem", envir =
"workFlow", subSymbol = "character")
: Remove a
normalizeActionItem
from a workFlow
. This
method is recursive and will also remove all dependent
views
and actionItems
.
signature(object = "normalizeActionItem")
: Print
details about the object.
Florian Hahne
workFlow
, actionItem
,
gateActionItem
,
transformActionItem
,
compensateActionItem
, view
showClass("view")