R: Assign values to edgePar of dendrogram's branches

assign_values_to_branches_edgePar {dendextend} | R Documentation

## Assign values to edgePar of dendrogram's branches

### Description

Go through the dendrogram branches and updates the values inside its edgePar

If the value has Inf then the value in edgePar will not be changed.

### Usage

    assign_values_to_branches_edgePar(dend, value, edgePar, skip_leaves = FALSE,
      warn = dendextend_options("warn"), ...)

### Arguments

`dend` | a dendrogram object
`value` | a new value scalar for the edgePar attribute.
`edgePar` | a character indicating the value inside edgePar to adjust. Can be either "col", "lty", or "lwd".
`skip_leaves` | logical (FALSE) - should the leaves be skipped/ignored?
`warn` | logical (default from dendextend_options("warn") is FALSE). Set if warning are to be issued, it is safer to keep this at TRUE, but for keeping the noise down, the default is FALSE.
`...` | not used

### Value

A dendrogram, after adjusting the edgePar attribute in all of its branches,

### See Also

get_root_branches_attr

### Examples

    # This failed before - now it works fine. (thanks to Martin Maechler)
    dend <- 1:2 %>% dist %>% hclust %>% as.dendrogram
    dend %>% set("branches_lty", 1:2) %>%
       set("branches_col", c("topbranch_never_plots", "black", "orange")) %>%
       plot

    ## Not run:

    dend <- USArrests[1:5,] %>% dist %>% hclust %>% as.dendrogram
    plot(dend)
    dend <- assign_values_to_branches_edgePar(dend=dend, value = 2, edgePar = "lwd")
    plot(dend)
    dend <- assign_values_to_branches_edgePar(dend=dend, value = 2, edgePar = "col")
    plot(dend)
    dend <- assign_values_to_branches_edgePar(dend=dend, value = "orange", edgePar = "col")
    plot(dend)
    dend2 <- assign_values_to_branches_edgePar(dend=dend, value = 2, edgePar = "lty")
    plot(dend2)

    dend2 %>% unclass %>% str

    ## End(Not run)

[Package dendextend version 1.8.0 Index]