actionItem-class {flowCore} | R Documentation |
Class and method to capture standard operations in a flow cytometry workflow.
actionItems
provide a means to bind standard operations on flow
cytometry data in a workflow. Usually, the user doesn't have to create these
objects, instead they will be automatically created when applying one of the
standard operations (gating, transformation, compensation) to a
workFlow
object. Each actionItem
creates one or several
new views
, which again can be the basis
to apply further operations. One can conceptualize actionItems
being
the edges in the workflow tree connecting
views
, which are the nodes of the tree.
There are more specific subclasses for the three possible types of
operation: gateActionItem
for gating operations,
transformActionItem
for transformations, and
compensateActionItem
for compensation operations. See their
documentation for details.
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 actionItem
is applied on.
alias
Object of class "fcAliasReference"
. A
reference to the alias table.
env
Object of class "environment"
. The
evaluation environment in the workFlow
.
A virtual Class: No objects may be created from it.
signature(object = "actionItem")
: Accessor
for the ID
slot.
signature(x = "actionItem")
: Accessor
for the name
slot.
signature(object = "actionItem")
: Accessor for
the parentView
slot. Note that the reference is resolved,
i.e., the view
object is returned.
signature(object = "actionItem")
: Get the alias table
from a actionItem
.
signature(symbol = "actionItem", envir = "workFlow",
subSymbol = "character")
: Remove a actionItem
from a
workFlow
. This method is recursive and will also
remove all dependent views
and
actionItems
.
Florian Hahne
workFlow
, gateActionItem
,
transformActionItem
,
compensateActionItem
, view
showClass("view")