Bug 16003 - heatmap scale argument: description not complete
Summary: heatmap scale argument: description not complete
Status: NEW
Alias: None
Product: R
Classification: Unclassified
Component: Documentation (show other bugs)
Version: R 3.1.1
Hardware: x86_64/x64/amd64 (64-bit) Mac OS X v10.6
: P5 enhancement
Assignee: R-core
URL:
Depends on:
Blocks:
 
Reported: 2014-09-30 19:31 UTC by epurdom
Modified: 2014-09-30 19:31 UTC (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description epurdom 2014-09-30 19:31:32 UTC
The heatmap scale argument says  

"character indicating if the values should be centered and scaled in either the row direction or the column direction, or none. The default is "row" if symm false, and "none" otherwise."

Looking at the function, it appears that if scale is chosen (either row or column) the scaling is only done *after* the hierarchical clustering is performed. So the scaling from the 'scale' argument is only for choosing the color scale, not for clustering the data. 

While the documentation is not technically incorrect, since the documentation doesn't say specifically either way, it seems to at least be an important aspect to document and I don't see it anywhere.

Personally, I think this is an odd choice, since I would want the color image to visualize the same thing that the clustering algorithm used in making the dendrogram. But I'm sure others would disagree.