R/check-scalar-hasValidNames.R

In acidgenomics/goalie: Assertive Check Functions

#' Does the input object have syntactically valid names?
#'
#' @name check-scalar-hasValidNames
#' @note Updated 2022-05-13.
#'
#' @inherit check
#' @inheritParams AcidRoxygen::params
#'
#' @seealso `validNames()`.
#'
#' @examples
#' ## TRUE ====
#' x <- list("a" = 1L, "b" = 2L)
#' print(names(x))
#' print(hasValidNames(x))
#'
#' x <- datasets::iris
#' print(hasValidDimnames(x))
#'
#' ## FALSE ====
#' x <- list(
#'     "1" = 1, # can't start with number
#'     "foo bar" = 2, # no spaces
#'     "foo-bar" = 3 # no hyphens
#' )
#' print(x)
#' print(hasValidNames(x))
#'
#' x <- datasets::mtcars
#' print(hasValidDimnames(x))
NULL



#' @rdname check-scalar-hasValidNames
#' @export
hasValidNames <- function(x) {
    names <- tryCatch(
        expr = names(x),
        error = function(e) {
            e
        }
    )
    if (is(names, "error")) {
        return(false(
            "{.fun %s} command on {.var %s} failed.",
            "names", .toName(x)
        ))
    }
    ok <- length(names) > 0L
    if (!isTRUE(ok)) {
        return(false(
            "{.var %s} doesn't have names.",
            .toName(x)
        ))
    }
    ok <- validNames(names)
    if (!isTRUE(ok)) {
        return(ok)
    }
    TRUE
}



#' @rdname check-scalar-hasValidNames
#' @export
hasValidDimnames <- function(x) {
    ## Check for `dimnames()` failure.
    dimnames <- tryCatch(
        expr = dimnames(x),
        error = function(e) {
            e
        }
    )
    if (is(dimnames, "error")) {
        return(false(
            "{.fun %s} command on {.var %s} failed.",
            "dimnames", .toName(x)
        ))
    }
    ## Row names.
    if (isTRUE(hasRownames(x))) {
        rn <- rownames(x)
        ok <- validNames(rn)
        if (!isTRUE(ok)) {
            return(ok)
        }
    }
    ## Column names.
    if (isTRUE(hasColnames(x))) {
        cn <- colnames(x)
        ok <- validNames(cn)
        if (!isTRUE(ok)) {
            return(ok)
        }
    }
    TRUE
}