view-class {flowCore} | R Documentation |
Class and method to capture the results of standard operations (called "views" here) in a flow cytometry workflow.
view(workflow, ID=paste("viewRef", guid(), sep="_"), name="default", data, action) parent(object) Data(object) action(object) alias(object, ...)
workflow |
An object of class |
object |
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. |
data, action |
References to the data and
|
... |
Further arguments that get passed to the generic. |
Views
provide a means to bind the results of standard
operations on flow cytometry data in a workflow. Each view can be
considered the outcome of one operation. There are more specific
subclasses for the three possible types of operation:
gateView
for gating operations,
transformView
for transformations, and
compensateView
for compensation operations. See their
documentation for details.
A reference to the view that is created inside the
workFlow
environment as a side effect of calling the
constructor.
The parent view (i.e., the view based on which the current view was created) for the parent method.
Objects should be created using the constructor view
, which
also assigns the view to a workFlow
object.
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
.
alias
:Object of class "fcAliasReference"
. A
reference to the alias table.
data
:Object of class "fcDataReference"
A
reference to the data that is associated to the view. See
gateView
for details on copying and subsetting of the raw
data in the context of gating.
signature(object = "view")
: Accessor for the
action
slot. Note that this returns the actual
actionItem
object, i.e.,
the reference gets resolved.
signature(object = "view")
: Accessor for the
data
slot. Note that this returns the actual data object,
i.e., the reference gets resolved.
signature(x = "view")
: Accessor to the
name
slot.
signature(object = "view")
: Get the alias table
from a view
.
signature(object = "view")
: The parent view,
i.e., the view based on which the current view was created.
signature(x = "view")
: Print details about the
object.
signature(symbol = "view", envir = "workFlow",
subSymbol = "character")
: Remove a view
from a
workFlow
. This method is recursive and will also
remove all dependent views
and
actionItems
.
signature(object = "view")
: Print details about the
object.
signature(x = "formula", data = "view")
: Plot
the data underlying the view.
signature(x = "view", data = "missing")
: Plot
the data underlying the view.
Florian Hahne
workFlow
,
gateView
,
transformView
,
compensateView
,
actionItem
showClass("view")