labels<-: "label" assignment operator

Description

"label" assignment operator for vectors, dendrogram, and hclust classes.

Usage

labels(object, ...) <- value
# S3 method for default
labels(object, ...) <- value
# S3 method for dendrogram
labels(object, ...) <- value
# S3 method for hclust
labels(object, order = TRUE, ...)
# S3 method for hclust
labels(object, ...) <- value
# S3 method for phylo
labels(object, ...)
# S3 method for phylo
labels(object, ...) <- value

Value

The updated object

Arguments

object: a variable name (possibly quoted) who's label are to be updated
...: parameters passed (not currently in use)
value: a value to be assigned to object's label
order: default is FALSE. Only relevant for extracting labels from an hclust object (with labels.hclust). Setting order=TRUE will return labels in their order in the dendrogram, instead of the riginal labels order retained from object$labels - which ususally corresponding to the row or column names of the dist object provided to the hclust function.

Author

Gavin Simpson, Tal Galili (with some ideas from Gregory Jefferis's dendroextras package)

Details

###################

Examples

Run this code

x <- 1:3
labels(x)
labels(x) <- letters[1:3]
labels(x) # [1] "a" "b" "c"
x
# a b c
# 1 2 3


# get("labels<-")

################
# Example for using the assignment with dendrogram and hclust objects:
hc <- hclust(dist(USArrests[1:3, ]), "ave")
dend <- as.dendrogram(hc)

labels(hc) # "Arizona" "Alabama" "Alaska"
labels(hc) <- letters[1:3]
labels(hc) # "a" "b" "c"
labels(dend) # "Arizona" "Alabama" "Alaska"
labels(dend) <- letters[1:3]
labels(dend) # "a" "b" "c"
suppressWarnings(labels(dend) <- LETTERS[1:2]) # will produce a warning
labels(dend) # "A" "B" "A"
labels(dend) <- LETTERS[4:6] # will replace the labels correctly
# (the fact the tree had duplicate labels will not cause a problem)
labels(dend) # "D" "E" "F"

Run the code above in your browser using DataLab