Skip to content

Commit

Permalink
Fix some roxygen2 all.equal.dendrogram and all.equal.dendlist issues
Browse files Browse the repository at this point in the history
  • Loading branch information
talgalili committed Nov 13, 2024
1 parent ed39cec commit 540e304
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 15 deletions.
4 changes: 2 additions & 2 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ S3method("labels<-",dendrogram)
S3method("labels<-",dist)
S3method("labels<-",hclust)
S3method("labels<-",phylo)
S3method(all,equal.dendlist)
S3method(all,equal.dendrogram)
S3method(all.equal,dendlist)
S3method(all.equal,dendrogram)
S3method(as.dendrogram,phylo)
S3method(as.dendrogram,pvclust)
S3method(as.dendrogram,varclus)
Expand Down
4 changes: 4 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
dendextend 1.19.0 (2024-11-12)
==============================
## BUG FIXES
- Fix some roxygen2 all.equal.dendrogram and all.equal.dendlist issues
- Fix dendlist in some edge cases (see ed39cec8dde07cf80728bdc896ab3a0f35684e32)

## OTHER NOTES
- Adding tests (props to @alecbuetow for all of his GREAT work), moving the test coverage from <40% to >95% !
See: https://app.codecov.io/github/talgalili/dendextend?branch=master
Expand Down
16 changes: 14 additions & 2 deletions R/all.equal.R
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@


#' @title Global Comparison of two (or more) dendrograms
#' @exportS3Method all.equal dendlist
#' @method all.equal dendlist
#' @exportS3Method all.equal dendrogram
#' @method all.equal dendrogram
#' @aliases
#' all.equal.dendlist
#' @description
Expand All @@ -49,6 +49,16 @@
#' Either TRUE (NULL for attr.all.equal) or a vector of mode "character" describing the differences

Check warning on line 49 in R/all.equal.R

View workflow job for this annotation

GitHub Actions / lint

file=R/all.equal.R,line=49,col=81,[line_length_linter] Lines should not be more than 80 characters. This line is 99 characters.
#' between target and current.
#'
#' @usage \method{all.equal}{dendrogram}(target, current,
#' use.edge.length = TRUE,
#' use.tip.label.order = FALSE,
#' use.tip.label = TRUE,
#' use.topology = TRUE,
#' tolerance = .Machine$double.eps^0.5,
#' scale = NULL, ...)
#'
#' \method{all.equal}{dendlist}(target, current, ...)
#'
#' @examples
#'
#' \dontrun{
Expand Down Expand Up @@ -174,6 +184,8 @@ all.equal.dendrogram <- function(target, current,


#' @export
#' @exportS3Method all.equal dendlist
#' @method all.equal dendlist
all.equal.dendlist <- function(target, current, ...) {
if (!is.dendlist(target)) stop("target needs to be a dendlist object")

Expand Down
20 changes: 9 additions & 11 deletions man/all.equal.dendrogram.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 540e304

Please sign in to comment.