Documentation Center

  • Trial Software
  • Product Updates

clusterGroup (clustergram)

Select cluster group

Syntax

clusterGroup(CGobj1, GroupIndex, Dim)
CGobj2 = clusterGroup(CGobj1, GroupIndex, Dim)
CGStruct = clusterGroup(CGobj1, GroupIndex, Dim, 'InfoOnly', InfoOnlyValue)
CGStruct = clusterGroup(CGobj1, GroupIndex, Dim, 'Color', ColorValue)

Input Arguments

CGobj1

Clustergram object created with the function clustergram.

GroupIndex

Positive integer specifying a group index for a cluster in CGobj1.

Dim

String specifying the dimension of the cluster group. Choices are 'column' or 'row'.

InfoOnlyValue

Controls the return of a structure (instead of a clustergram object) containing information about the cluster group. Choices are true or false (default).

ColorValue

Color to highlight the dendrogram of the selected cluster group. Specify the color with one of the following:

  • Three-element numeric vector of RGB values

  • String containing a predefined single-letter color code

  • String containing a predefined color name

For example, to use cyan, enter [0 1 1], 'c', or 'cyan'. For more information on specifying colors, see ColorSpec.

Output Arguments

CGobj2

Clustergram object created from the selected cluster group in CGobj1.

CGStruct

Structure containing information about the cluster group in the following fields:

  • GroupNames — Cell array of text strings containing the names of the row or column groups in the selected cluster group.

  • RowNodeNames — Cell array of text strings containing the names of the row nodes in the selected cluster group.

  • ColumnNodeNames — Cell array of text strings containing the names of the column nodes in the selected cluster group.

  • ExprValues — An M-by-N matrix of intensity values, where M and N are the number of row nodes and of column nodes respectively in the selected cluster group. If the matrix contains gene expression data, typically each row corresponds to a gene and each column corresponds to a sample.

Description

clusterGroup(CGobj1, GroupIndex, Dim) selects and highlights a cluster group in the Clustergram window, specified by a clustergram object, group index, and dimension.

CGobj2 = clusterGroup(CGobj1, GroupIndex, Dim) creates a clustergram object from the specified cluster group. This syntax is equivalent to selecting the Export Group to Workspace command from the context menu after right-clicking a group in the Clustergram window.

CGStruct = clusterGroup(CGobj1, GroupIndex, Dim, 'InfoOnly', InfoOnlyValue) controls the return of a structure (instead of a clustergram object) containing information about the cluster group. Choices are true or false (default). Setting this property to true is equivalent to selecting the Export Group Info to Workspace command from the context menu after right-clicking a group in the Clustergram window.

CGStruct = clusterGroup(CGobj1, GroupIndex, Dim, 'Color', ColorValue) specifies a color for the dendrogram of the selected cluster group.

Examples

Select and highlight column cluster Group 4 in the Clustergram window, from the clustergram object created in the first two steps of the Examples section of the clustergram function reference page.

clusterGroup(cgo,4,'column')

See Also

| | |

Was this topic helpful?