R/keepOnlyAtomicCols-methods.R

In acidgenomics/acidbase: Acid Genomics Base Functions

#' @name keepOnlyAtomicCols
#' @inherit AcidGenerics::keepOnlyAtomicCols description return title
#' @note Updated 2023-09-08.
#'
#' @inheritParams AcidRoxygen::params
#' @param ... Additional arguments.
#'
#' @examples
#' ## DFrame ====
#' object <- S4Vectors::DataFrame(
#'     "a" = I(list(
#'         c(1L, 2L),
#'         c(3L, 4L),
#'         c(5L, 6L)
#'     )),
#'     "b" = c(TRUE, TRUE, FALSE),
#'     "c" = c("a", "b", "c"),
#'     row.names = c("x", "y", "z")
#' )
#' print(object)
#' object <- keepOnlyAtomicCols(object)
#' print(object)
NULL



## Updated 2023-09-08.
`keepOnlyAtomicCols,data.frame` <- # nolint
    function(object) {
        assert(hasDims(object))
        j <- bapply(
            X = object[1L, , drop = FALSE],
            FUN = is.atomic
        )
        assert(
            any(j),
            msg = "No atomic columns in object."
        )
        out <- object[, j, drop = FALSE]
        out
    }



## Updated 2023-09-08.
`keepOnlyAtomicCols,DFrame` <- # nolint
    `keepOnlyAtomicCols,data.frame`



#' @rdname keepOnlyAtomicCols
#' @export
setMethod(
    f = "keepOnlyAtomicCols",
    signature = signature(object = "DFrame"),
    definition = `keepOnlyAtomicCols,DFrame`
)

#' @rdname keepOnlyAtomicCols
#' @export
setMethod(
    f = "keepOnlyAtomicCols",
    signature = signature(object = "data.frame"),
    definition = `keepOnlyAtomicCols,data.frame`
)