R/is-one-dim.r

In gastonstat/tester: Tests and checks characteristics of R objects

#' @title Test if an object has one-dimension
#' 
#' @description
#' Returns \code{TRUE} if an object is a vector or a one-dimensional
#' matrix, \code{FALSE} otherwise
#' 
#' @param x an R object
#' @return whether x is one-dimensional
#' @seealso \code{\link{is_multidim}}
#' @export
#' @examples
#' # vector
#' is_one_dim(1:5)  # TRUE
#' 
#' # factor
#' is_one_dim(iris$Species)  # TRUE
#' 
#' # one row matrix
#' is_one_dim(matrix(1:5, 1, 5))  # TRUE
#' 
#' # one column matrix
#' is_one_dim(matrix(1:5, 5, 1))  # TRUE
#' 
#' # general matrix (nrow>1, ncol>1)
#' is_one_dim(matrix(1:9, 3, 3))  # FALSE
#' 
#' # general data frame
#' is_one_dim(iris)  # FALSE
is_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 Test if an object is multi-dimensional
#' 
#' @description
#' Returns \code{TRUE} if an object is a matrix or data frame with at
#' least 2 rows and at least 2 columns, \code{FALSE} otherwise
#' 
#' @param x an R object
#' @return whether x is multi-dimensional
#' @seealso \code{\link{is_one_dim}}
#' @export
#' @examples
#' # general matrix (nrow>1, ncol>1)
#' is_multidim(matrix(1:9, 3, 3))  # TRUE
#' 
#' # general data frame
#' is_multidim(iris)  # TRUE
#' 
#' # vector
#' is_multidim(1:5)  # FALSE
#' 
#' # factor
#' is_multidim(iris$Species)  # FALSE
#' 
#' # one row matrix
#' is_multidim(matrix(1:5, 1, 5))  # FALSE
#' 
#' # one column matrix
#' is_multidim(matrix(1:5, 5, 1))  # FALSE
is_multidim <- function(x) 
{
  multidim = TRUE
  if (lacks_dim(x)) {
    return(FALSE)
  } else {
    if (dim(x)[1L] > 1 && dim(x)[2L] > 1) {
      multidim = TRUE
    } else {
      multidim = FALSE
    }
  }
  # output
  multidim
}