clustergram object - Object containing hierarchical clustering analysis data

String or number specifying the dimension for standardizing the data values. This property transforms the standardized values so that the mean is 0 and the standard deviation is 1 in the specified dimension. Choices are:

• 'column' or 1 — Standardize along the columns of data.

• 'row' or 2 (default) — Standardize along the rows of data.

• 'none' or 3 — Do not standardize.

String or number specifying the dimension for clustering the values in the data. Choices are:

• 'column' or 1 — Cluster along the columns of data only, which results in clustered rows.

• 'row' or 2 — Cluster along the rows of data only, which results in clustered columns.

• 'all' or 3 (default) — Cluster along the columns of data, then cluster along the rows of row-clustered data.

String specifying the distance metric to pass to the pdist function (Statistics Toolbox™ software) to calculate the pairwise distances between rows. For information on choices, see the pdist function. Default is 'euclidean'.

Note   If the distance metric requires extra arguments, then RowPDistValue is a cell array. For example, to use the Minkowski distance with exponent P, you would use {'minkowski', P}.

String specifying the distance metric to pass to the pdist function (Statistics Toolbox software) to calculate the pairwise distances between columns. For information on choices, see the pdist function. Default is 'euclidean'.

Note   If the distance metric requires extra arguments, then ColumnPDistValue is a cell array. For example, to use the Minkowski distance with exponent P, you would use {'minkowski', P}.

Tip   Disabling the optimal leaf ordering calculation can be useful when working with large data sets, because this calculation consumes a lot of memory and time.

Either of the following:

• M-by-3 matrix of RGB values

• Name or function handle of a function that returns a colormap, such as redgreencmap or redbluecmap

Default is redgreencmap.

Positive scalar specifying the display range of standardized values. Default is 3, which means there is a color variation for values between –3 and 3, but values >3 are the same color as 3, and values < –3 are the same color as –3.

For example, if you specify redgreencmap for the 'Colormap' property, pure red represents values ≥ DisplayRangeValue, and pure green represents values ≤ –DisplayRangeValue.

Either of the following:

• Scalar

• Two-element vector

This property specifies the ratio of space that the row and column dendrograms occupy relative to the heat map. If DisplayRatio is a scalar, it is used as the ratio for both dendrograms. If DisplayRatio is a two-element vector, the first element is used for the ratio of the row dendrogram width to the heat map width, and the second element is used for the ratio of the column dendrogram height to the heat map height. The second element is ignored for one-dimensional clustergrams. Default is 1/5.

One of the following:

• Name of a function that imputes missing data.

• Handle to a function that imputes missing data.

• Cell array where the first element is the name of or handle to a function that imputes missing data. The remaining elements are property name/property value pairs used as inputs to the function.

Shows and hides the dendrogram tree diagrams with the clustergram. Choices are 'on' (default) or 'off'.

Tip   After displaying a clustergram in a Clustergram window, click the Show Dendrogram button on the toolbar to show and hide the dendrograms.

Structure or structure array containing information for annotating the groups (clusters) of rows determined by the clustergram function. The structure or structures contain the following fields. If a single structure, then the fields contain a cell array of elements. If a structure array, then the fields contain one element:

• GroupNumber — Scalar specifying the row group number to annotate.

• Annotation — String specifying text to annotate the row group.

• Color — String or three-element vector of RGB values specifying a color to label the row group. For more information on specifying colors, see ColorSpec. If this field is empty, default is 'blue'.

Structure or structure array containing information for annotating the groups (clusters) of columns determined by the clustergram function. The structure or structures contain the following fields. If a single structure, then the fields contain a cell array of elements. If a structure array, then the fields contain one element:

• GroupNumber — Scalar specifying the column group number to annotate.

• Annotation — String specifying text to annotate the column group.

• Color — String or three-element vector of RGB values specifying a color to label the column group. For more information on specifying colors, see ColorSpec. If this field is empty, default is 'blue'.

Read-only string specifying the location of the column labels. For clustergram objects, it is always 'bottom' (default).

Read-only string specifying the location of the row labels. For clustergram objects, it is always 'right' (default).

Structure or structure array containing color information for labeling the rows (y-axis) of the clustergram. The structure or structures contain the following fields. If a single structure, then the fields contain a cell array of elements. If a structure array, then the fields contain one element:

• Labels — String specifying a row label listed in the RowLabels vector.

• Colors — String or three-element vector of RGB values specifying a color for the row label specified in the Labels field. For more information on specifying colors, see ColorSpec. If this field is empty, default colors are assigned to the row label.

Structure or structure array containing color information for labeling the columns (x-axis) of the clustergram. The structure or structures contain the following fields. If a single structure, then the fields contain a cell array of elements. If a structure array, then the fields contain one element:

• Labels — String specifying a column label listed in the ColumnLabels vector.

• Colors — String or three-element vector of RGB values specifying a color for the column label specified in the Labels field. For more information on specifying colors, see ColorSpec. If this field is empty, default colors are assigned to the column label.

Controls the display of colored markers instead of colored text for the row labels and column labels. Choices are true or false (default).

Numeric value in degrees rotation specifying the orientation of row (y-axis) labels. Default is 0 degrees, which is horizontal. Positive values cause counterclockwise rotation.

Numeric value in degrees rotation specifying the orientation of column (x-axis) labels. Default is 90 degrees, which is vertical. Values greater than 90 degrees cause counterclockwise rotation.

Controls the display of intensity values on each area of the heat map. Choices are true or false (default).

Tip   After displaying a clustergram in a Clustergram window, click the Annotate button on the toolbar to show and hide the intensity values.

Positive integer specifying the precision of the intensity values when displayed on the heat map. Default is 2.

String or three-element vector of RGB values specifying a color, which is used for the text of the intensity values when displayed on the heat map. Default is 'white'. For more information on specifying colors, see ColorSpec.