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