flowWorkspace (version 3.16.0)

getGate,GatingHierarchy,character-method: Return the flowCore gate definition associated with a node in a GatingHierarchy/GatingSet.

Description

Return the flowCore gate definition object associated with a node in a GatingHierarchy or GatingSet object.

Usage

"getGate"(obj, y)
"getGate"(obj, y)
"getGate"(obj, y)

Arguments

obj

A GatingHierrarchy or GatingSet

y

A character the name or full(/partial) gating path of the node of interest.

Value

A gate object from flowCore. Usually a polygonGate, but may be a rectangleGate. Boolean gates are represented by a "BooleanGate" S3 class. This is a list boolean gate definition that references populations in the GatingHierarchy and how they are to be combined logically. If obj is a GatingSet, assuming the trees associated with each GatingHierarchy are identical, then this method will return a list of gates, one for each sample in the GatingSet corresponding to the same population indexed by y.

See Also

getData getNodes

Examples

## Not run: 	#gh is a GatingHierarchy
#     getGate(gh, "CD3") #return the gate for the fifth node in the tree, but fetch it by name.
#     #G is a GatingSet
#     getGate(G, "CD3") #return a list of gates for the fifth node in each tree
#   ## End(Not run)