flowWorkspace (version 3.16.0)

getNodes,GatingSet-method: Get the names of all nodes from a gating hierarchy.

Description

getNodes returns a character vector of names of the nodes (populations) in the GatingSet.

Usage

"getNodes"(x, y = NULL, order = "regular", path = "full", showHidden = FALSE, ...)

Arguments

x

A GatingSet Assuming the gating hierarchy are identical within the GatingSet, the Gating tree of the first sample is used to query the node information.

y

A character not used.

order

order=c("regular","tsort","bfs") returns the nodes in regular, topological or breadth-first sort order. "regular" is default.

path

A character or numeric scalar. when numeric, it specifies the fixed length of gating path (length 1 displays terminal name). When character, it can be either 'full' (full path, which is default) or 'auto' (display the shortest unique gating path from the bottom of gating tree).

showHidden

logical whether to include the hidden nodes

...

Additional arguments.

Value

getNodes returns a character vector of node/population names, ordered appropriately.

Details

integer indices of nodes are based on regular order,so whenver need to map from character node name to integer node ID,make sure to use default order which is regular.

Examples

## Not run: 
#     #G is a gating hierarchy
#     getNodes(G, path = 1])#return node names (without prefix)
#     getNodes(G,path = "full")#return the full path
#     getNodes(G,path = 2)#return the path as length of two
#     getNodes(G,path = "auto)#automatically determine the length of path
#     setNode(G,"L","lymph")
#   ## End(Not run)