flowCore (version 1.38.2)

subsettingActionItem-class: Class "subsettingActionItem"

Description

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

Usage

subsettingActionItem(ID = paste("subActionRef", guid(), sep = "_"),
name = paste("action", identifier(get(subsetting)), sep = "_"),
parentView, subsetting, 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, subsetting

References to the parent view and subsetting objects, respectively.

Value

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 from the Class

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.

Slots

subsetting:

Object of class "fcSubsettingReference". A reference to the subsetting object that is used for the 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 subsettingActionItem is applied on.

env:

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

Extends

Class "actionItem", directly.

Methods

print

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

Rm

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.

show

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

Details

subsettingActionItems provide a means to bind subsetting operations in a workflow. Each subsettingActionItem represents a single subsetting.

See Also

workFlow, actionItem, gateActionItem, transformActionItem, compensateActionItem, view

Examples

showClass("view")