R/18_others.R

In SigBridgeRUtils: Some Utilities & Base Supports for 'SigBridgeR'

#' @title Check all the Objects Are Identical
#'
#' @description
#' all_identical checks if all provided objects are pairwise identical and returns
#' a symmetric matrix showing the comparison results between all object pairs.
#'
#' @param ... Objects to compare for identity
#' @param names Optional character vector of names for the objects. If not provided,
#' objects will be named as "Obj1", "Obj2", etc.
#'
#' @return A symmetric logical matrix where entry \[i, j\] indicates whether
#' object i is identical to object j. The matrix has dimensions n x n where
#' n is the number of objects, with row and column names from the names parameter.
#'
#' @details
#' This function provides a comprehensive way to compare multiple objects at once,
#' returning a matrix that shows all pairwise comparisons. This is particularly
#' useful for testing and validation scenarios where you need to verify that
#' multiple objects are identical.
#'
#' @examples
#' # Compare identical objects
#' x <- 1:5
#' y <- 1:5
#' z <- 1:5
#'
#' # All objects are identical
#' result <- all_identical(x, y, z)
#' print(result)
#'
#' # Compare different objects with custom names
#' a <- 1:3
#' b <- 1:5
#' c <- 1:3
#'
#' result2 <- all_identical(a, b, c, names = c("first", "second", "third"))
#' print(result2)
#'
#' # Single object case
#' single_result <- all_identical(x)
#' print(single_result)
#'
#' @seealso
#' [identical()] for pairwise object comparison,
#' [matrix()] for creating matrices
#' @export
all_identical <- function(..., names = NULL) {
  objs <- list(...)
  n <- length(objs)

  if (is.null(names)) {
    names <- paste0("Obj", seq_len(n))
  } else if (length(names) != n) {
    cli::cli_abort(c(
      "x" = "The length of `names` must be equal to the number of objects."
    ))
  }

  result <- matrix(TRUE, n, n, dimnames = list(names, names))

  if (n > 1L) {
    for (i in seq_len(n - 1L)) {
      for (j in (i + 1L):n) {
        is_identical <- identical(objs[[i]], objs[[j]])
        result[i, j] <- is_identical
        result[j, i] <- is_identical
      }
    }
  }

  result
}