flowCore (version 1.38.2)

transformActionItem-class: Class "transformActionItem"

Description

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

Usage

transformActionItem(ID = paste("transActionRef", guid(), sep = "_"), name=paste("action", identifier(get(transform)), sep = "_"), parentView, transform, 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, transform

References to the parent view and transform objects, respectively.

Value

A reference to the transformActionItem that is created inside the workFlow environment as a side effect of calling the add method.A transformActionItem object for the constructor.

Objects from the Class

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

Slots

transform:

Object of class "fcTransformReference". A reference to the transform object that is used for the transformation 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 transformActionItem is applied on.

env:

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

Extends

Class "actionItem", directly.

Methods

print

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

Rm

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

show

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

Details

transformActionItems provide a means to bind transformation operations in a workflow. Each transformActionItem represents a single transform.

See Also

workFlow, actionItem, gateActionItem, compensateActionItem, view

Examples

showClass("view")