gateActionItem-class {flowCore}R Documentation

Class "gateActionItem"

Description

Class and method to capture gating operations in a flow cytometry workflow.

Usage

gateActionItem(ID = paste("gateActionRef", guid(), sep = "_"), name =
               paste("action", identifier(get(gate)), sep = "_"), parentView, gate,
               filterResult, workflow)

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.

parentView, gate, filterResult

References to the parent view, filter, and filterResult objects, respectively.

Details

gateActionItems provide a means to bind gating operations in a workflow. Each gateActionItem represents a single filter.

Value

A reference to the gateActionItem that is created inside the workFlow environment as a side effect of calling the add method.

A gateActionItem object for the constructor.

Slots

gate

Object of class "fcFilterReference". A reference to the filter that is used for the gating operation.

filterResult

Object of class "fcFilterResultReference". A reference to the filterResult produced by the gating 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 gateActionItem is applied on.

env

Object of class "environment". The evaluation environment in the workFlow.

Objects from the Class

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

Methods

gate

signature(object = "gateActionItem"): Accessor to the gate slot. Note that this resolved the reference, i.e., the filter object is returned.

print

signature(x = "gateActionItem"): Print details about the object.

Rm

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

show

signature(object = "gateActionItem"): Print details about the object.

summary

signature(object = "gateActionItem"): Summarize the gating operation and return the appropriate filterSummary object.

Extends

Class "actionItem", directly.

Author(s)

Florian Hahne

See Also

workFlow, actionItem, transformActionItem, compensateActionItem, view

Examples


showClass("view")


[Package flowCore version 1.50.0 Index]