compensateActionItem-class {flowCore}R Documentation

Class "compensateActionItem"

Description

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

Usage

compensateActionItem(ID = paste("compActionRef", guid(), sep = "_"),
                     name = paste("action", identifier(get(compensate)), sep = "_"),
                     parentView, compensate, 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, compensate

References to the parent view and compensation objects, respectively.

Details

compensateActionItems provide a means to bind compensation operations in a workflow. Each compensateActionItem represents a single compensation.

Value

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

A compensateActionItem object for the constructor.

Slots

compensate

Object of class "fcCompensateReference". A reference to the compensation object that is used for the compensation 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 compensateActionItem 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 compensateActionItem from a compensation object and directly assigns it to a workFlow. Alternatively, one can use the compensateActionItem constructor function for more programmatic access.

Extends

Class "actionItem", directly.

Methods

print

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

Rm

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

show

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

Author(s)

Florian Hahne

See Also

workFlow, actionItem, gateActionItem, transformActionItem, view

Examples


showClass("view")


[Package flowCore version 1.50.0 Index]