UPDATED DOCS for set - gave a bit more details about arguments when…

… using `by_labels_branches_col`
talgalili · Jan 25, 2025 · d38e65d · d38e65d
1 parent e094f90
commit d38e65d
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 12 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -2,7 +2,7 @@ Package: dendextend
 Type: Package
 Title: Extending 'dendrogram' Functionality in R
 Version: 1.19.1
-Date: 2025-01-17
+Date: 2025-01-25
 Authors@R: c(person("Tal", "Galili", role = c("aut", "cre", "cph"), email =
     "[email protected]", comment = "https://www.r-statistics.com"),
     person("Yoav", "Benjamini", email = "[email protected]",role = "ths"),

diff --git a/NEWS.md b/NEWS.md
@@ -1,8 +1,10 @@
-dendextend 1.19.1 (2025-01-17)
+dendextend 1.19.1 (2025-01-25)
 ==============================
 ## BUG FIXES
 - Remove redundent `requireNamespace <- NULL`
 
+## UPDATED DOCS:
+- `set` - gave a bit more details about arguments when using `by_labels_branches_col`
 
 dendextend 1.19.0 (2024-11-15)
 ==============================

diff --git a/R/set.dendrogram.R b/R/set.dendrogram.R
@@ -242,11 +242,11 @@
 #'
 #' old_labels <- labels(dend)
 #' dend %>%
-#'   set("labels", seq_len(nleaves(dend))) %>%
-#'   set("by_labels_branches_col", c(1:4, 7)) %>%
-#'   set("by_labels_branches_lwd", c(1:4, 7)) %>%
-#'   set("by_labels_branches_lty", c(1:4, 7)) %>%
-#'   set("labels", old_labels) %>%
+#' set("labels", seq_len(nleaves(dend))) %>%
+#'    set("by_labels_branches_col", value = c(1:4, 7), TF_values = 'gold') %>%
+#'    set("by_labels_branches_lwd", value = c(1:4, 7), TF_values = 5) %>%
+#'    set("by_labels_branches_lty", value = c(1:4, 7), TF_values = 2) %>%
+#'    set("labels", old_labels) %>%
 #'   plot()
 #'
 #' dend %>%

diff --git a/man/set.Rd b/man/set.Rd