R/auxiliar-functions.r

In gastonstat/blockberry: Wireframe for multiblock objects

# @title Test if an object has one-dimension
# 
# @description
# Returns TRUE if an object is a vector or one-dimensional matrix,
# FALSE otherwise
# 
# @param x an R object
# @return whether x is one-dimensional
# @keywords internal
check_one_dim <- function(x)
{
  one_dim = TRUE
  if (lacks_dim(x)) {
    if (is.list(x)) one_dim = FALSE
  } else {
    if (dim(x)[1L] > 1 && dim(x)[2L] > 1)
      one_dim = FALSE
  }
  # output
  one_dim
}




#' @title Non Conformable Arguments
#' 
#' @description
#' Stops execution of a binary operator when arguments are 
#' non-conformable
#' 
#' @param operator name of operator
#' @return stop message
#' @keywords internal
incompatible_args <- function(operator) {
  stop(paste("\nnon-conformable arguments for", operator))
}

#' @title Multiblock Required
#' 
#' @description
#' Stops execution of a binary operator when a multiblock
#' was expected
#' 
#' @param operator name of operator
#' @return stop message
#' @keywords internal
non_multiblock_args <- function(operator) {
  stop(paste("\na multiblock is required for", operator))
}

#' @title Invalid Arguments
#' 
#' @description
#' Stops execution of a binary operator when arguments are 
#' invalid
#' 
#' @param operator name of operator
#' @return stop message
#' @keywords internal
invalid_args <- function(operator) {
  stop(paste("\ninvalid arguments for", operator))
}

#' @title Requires Numeric Arguments
#' 
#' @description
#' Stops execution when arguments are non-numeric
#' 
#' @param operator name of operator
#' @return stop message
#' @keywords internal
non_numeric_args <- function(operator) {
  stop(paste("\n", operator, " requires numeric arguments", sep=""))
}