clustergram object - Object containing hierarchical clustering analysis data

Numeric value that specifies the dimension for standardizing the values in the data. The standardized values are transformed so that the mean is 0 and the standard deviation is 1 in the specified dimension. Choices are:

• 1 — Standardize along the columns of data.

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

• 3 — Do not perform standardization.

Numeric value that specifies the dimension for clustering the values in the data. Choices are:

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

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

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

String that specifies the distance metric to pass to the pdist function (Statistics Toolbox™ software) to use 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 that specifies the distance metric to pass to the pdist function (Statistics Toolbox software) to use 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}.

Note   Disabling the optimal leaf ordering calculation can be useful when working with large data sets because this calculation uses a large amount of memory and can be very time consuming.

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 that specifies 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 will be the same color as 3, and values < -3 will be 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

It specifies the ratio of space that the row and column dendrograms occupy relative to the heat map. If RatioValue is a scalar, it is used as the ratio for both dendrograms. If RatioValue 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.

Any 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 and the remaining elements are property name/property value pairs used as inputs to the function.

Optional structure array for annotating the groups (clusters) of rows determined by the clustergram function. Each structure in the array represents a group of rows and contains the following fields:

• GroupNumber — 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, which is used to label the row group. For more information on specifying colors, see colorspec. If this field is empty, default is 'blue'.

Optional structure array for annotating groups (clusters) of columns determined by the clustergram function. Each structure in the array represents a group of columns and contains the following fields:

• GroupNumber — 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, which is used to label the column group. For more information on specifying colors, see colorspec. If this field is empty, default is 'blue'.