Retrieve information about clustergram object
get(
CGobj
)CGStruct
= get(CGobj
)PropertyValue
= get(CGobj
,
'PropertyName
')
[Property1Value
, Property2Value
,
...] = get(CGobj
, 'Property1Name
',
'Property2Name
', ...)
CGobj  Clustergram object created with the function clustergram . 
PropertyName  Property name for a clustergram object. 
get(
displays
all properties and their current values of CGobj
)CGobj
,
a clustergram object.
returns
all properties of CGStruct
= get(CGobj
)CGobj
, a clustergram
object, to CGStruct
, a scalar structure,
in which each field name is a property of a clustergram object, and
each field contains the value of that property.
returns the
value of the specified property of PropertyValue
= get(CGobj
,
'PropertyName
')CGobj
,
a clustergram object.
[
returns
the values of the specified properties of Property1Value
, Property2Value
,
...] = get(CGobj
, 'Property1Name
',
'Property2Name
', ...)CGobj
,
a clustergram object.
Properties of a Clustergram Object
Property  Description 

RowLabels  Vector of numbers or cell array of text
strings to label the rows in the dendrogram and heat map. Default
is a vector of values 1 through M,
where M is the number of rows in Data ,
the matrix of data used by the clustergram function
to create the clustergram object. 
ColumnLabels  Vector of numbers or cell array of text
strings to label the columns in the dendrogram and heat map. Default
is a vector of values 1 through N,
where N is the number of columns in Data ,
the matrix of data used by the clustergram function
to create the clustergram object. 
RowGroupNames  A cell array of text strings containing the names of the row groups exported to a clustergram object created using the Export Group to Workspace command in the Clustergram window. 
RowNodeNames  A cell array of text strings containing the names of the row nodes exported to a clustergram object created using the Export Group to Workspace command in the Clustergram window. 
ColumnGroupNames  A cell array of text strings containing the names of the column groups exported to a clustergram object created using the Export Group to Workspace command in the Clustergram window. 
ColumnNodeNames  A cell array of text strings containing the names of the column nodes exported to a clustergram object created using the Export Group to Workspace command in the Clustergram window. 
ExprValues  An MbyN matrix of data, where M and N are the number of row nodes and column nodes respectively, exported to a clustergram object created using the Export Group to Workspace command in the Clustergram window. If the matrix contains gene expression data, typically each row corresponds to a gene and each column corresponds to a sample. 
Standardize  Text string 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. Possibilities are:

Cluster  Text string that specifies the dimension for clustering the values in the data. Possibilities are:

RowPdist  String or cell array that specifies
the distance metric and optional arguments passed to the 
ColumnPdist  String or cell array that specifies
the distance metric and optional arguments passed to the 
Linkage  String or twoelement cell array of strings
that specifies the linkage method passed to the linkage function
(Statistics and Machine Learning Toolbox software) used to create the hierarchical
cluster tree for rows and columns. If a twoelement cell array of
strings, the first element is for linkage between rows, and the second
element is for linkage between columns. For information on possibilities,
see the linkage function. 
Dendrogram  Scalar or twoelement numeric vector
or cell array that specifies the 'colorthreshold' property
passed to the dendrogram function (Statistics and Machine Learning Toolbox software)
used to create the dendrogram plot. If a twoelement numeric vector
or cell array, the first element is for the rows, and the second element
is for the columns. For more information, see the dendrogram function. 
OptimalLeafOrder  Property that enabled or disabled the
optimal leaf ordering calculation, which determines the leaf order
that maximizes the similarity between neighboring leaves. Possibilities
are 1 (enabled) or 0 (disabled). 
LogTrans  Controlled the log_{2} transform of the
data from natural scale. Possibilities are 1 (true)
or 0 (false). 
Colormap  Either of the following:

DisplayRange  Positive scalar that specifies the display range of standardized values. For example,
if you specify 
Symmetric  Property to force the color scale of
the heat map to be symmetric around zero. Possibilities are 1 (true)
or 0 (false). 
Ratio  Either of the following:
It specifies the ratio of space that the row
and column dendrograms occupy relative to the heat map. If 
Impute  Any of the following:

RowMarkers  Optional structure array for annotating
the groups (clusters) of rows determined by the

ColumnMarkers  Optional structure array for annotating
groups (clusters) of columns determined by the

Load the MATfile, provided with the Bioinformatics Toolbox™ software,
that contains yeastvalues
, a matrix of gene expression
data.
load filteredyeastdata
Create a clustergram object and display the dendrograms
and heat map from the gene expression data in the first 30 rows of
the yeastvalues
matrix and standardize along the
rows of data.
cgo = clustergram(yeastvalues(1:30,:),'Standardize', 'row')
Clustergram object with 30 rows of nodes and 7 columns of nodes.
Use the get
method to display the
properties of the clustergram object, cgo
.
get(cgo)
Cluster: 'ALL' RowPDist: {'Euclidean'} ColumnPDist: {'Euclidean'} Linkage: {'Average'} Dendrogram: {} OptimalLeafOrder: 1 LogTrans: 0 DisplayRatio: [0.2000 0.2000] RowGroupMarker: [] ColumnGroupMarker: [] ShowDendrogram: 'on' Standardize: 'ROW' Symmetric: 1 DisplayRange: 3 Colormap: [11x3 double] ImputeFun: [] ColumnLabels: {'2' '1' '3' '4' '5' '7' '6'} RowLabels: {30x1 cell} ColumnLabelsRotate: 90 RowLabelsRotate: 0 ColumnLabelsLocation: 'bottom' RowLabelsLocation: 'right' Annotate: 'off' AnnotPrecision: 2 AnnotColor: 'w' ColumnLabelsColor: [] RowLabelsColor: [] LabelsWithMarkers: 0
Export a clustergram object of a group (Group
19
) of rows to the MATLAB^{®} Workspace by rightclicking
a node in the row dendrogram, and then selecting Export
Group to Workspace.
In the Export to Workspace dialog box, type cgo2 for the Workspace variable name for the clustergram object, and then click OK.
Use the get
method to display the
properties of cgo2
, the clustergram object of the
exported group.
get(cgo2)
Cluster: 'ALL' RowPDist: {'Euclidean'} ColumnPDist: {'Euclidean'} Linkage: {'Average'} Dendrogram: {} OptimalLeafOrder: 1 LogTrans: 0 DisplayRatio: [0.2000 0.2000] RowGroupMarker: [] ColumnGroupMarker: [] ShowDendrogram: 'on' Standardize: 'ROW' Symmetric: 1 DisplayRange: 3 Colormap: [11x3 double] ImputeFun: [] ColumnLabels: {'2' '1' '3' '4' '5' '7' '6'} RowLabels: {9x1 cell} ColumnLabelsRotate: 90 RowLabelsRotate: 0 ColumnLabelsLocation: 'bottom' RowLabelsLocation: 'right' Annotate: 'off' AnnotPrecision: 2 AnnotColor: 'w' ColumnLabelsColor: [] RowLabelsColor: [] LabelsWithMarkers: 0
clustergram
 plot
 set
 view