R/check-vector-isDirectory.R

In acidgenomics/goalie: Assertive Check Functions

#' Does the input contain a directory?
#'
#' @name check-vector-isDirectory
#' @note Updated 2023-09-29.
#'
#' @inherit check
#' @inheritParams AcidRoxygen::params
#'
#' @seealso
#' - `dir.exists()`.
#' - `R.utils::isDirectory()`.
#'
#' @examples
#' ## TRUE ====
#' isDirectory(c("~", "."))
#' isADirectory("~")
#'
#' ## FALSE ====
#' isDirectory(1L)
NULL



## Vector ======================================================================

#' @describeIn check-vector-isDirectory Vectorized.
#' @export
isDirectory <- function(x) {
    ok <- hasLength(x)
    if (!isTRUE(ok)) {
        return(ok)
    }
    ok <- isCharacter(x)
    if (!isTRUE(ok)) {
        ko <- rep(x = FALSE, times = length(x))
        return(setCause(ko, false = "not character"))
    }
    ok <- dir.exists(x)
    setCause(ok, false = "not dir")
}



## Scalar ======================================================================

#' @describeIn check-vector-isDirectory Scalar.
#' @export
isADirectory <- function(x, nullOk = FALSE) {
    if (isTRUE(nullOk) && is.null(x)) {
        return(TRUE)
    }
    ok <- isString(x)
    if (!isTRUE(ok)) {
        return(ok)
    }
    ok <- isDirectory(x)
    if (!isTRUE(ok)) {
        return(ok)
    }
    TRUE
}

#' @describeIn check-vector-isDirectory Scalar.
#' @export
allAreDirectories <- function(x) {
    ok <- isDirectory(x)
    if (!all(ok)) {
        return(falseFromVector(ok))
    }
    TRUE
}



## Aliases =====================================================================

#' @describeIn check-vector-isDirectory Short alias for [isDirectory()].
#' @export
isDir <- isDirectory

#' @describeIn check-vector-isDirectory Short alias for [isADirectory()].
#' @export
isADir <- isADirectory

#' @describeIn check-vector-isDirectory Short alias for [allAreDirectories()].
#' @export
allAreDirs <- allAreDirectories