R/missingCats.r

In adamlilith/fasterRaster: Faster Raster and Spatial Vector Processing Using 'GRASS GIS'

#' Values in a categorical raster with no assigned category
#'
#' @description This function reports the values in a categorical `GRaster` that have no matching category label in its "levels" table.
#'
#' `GRaster`s can represent categorical data. Cell values are actually integers, each corresponding to a category, such as "desert" or "wetland." A categorical raster is associated with a table that matches each value to a category name.
#'
#' @param x A `GRaster`.
#'
#' @param layer Numeric integers, logical vector, or character: Layer(s) for which to obtain missing categories.
#' 
#' @returns A numeric vector (if `x`is just one layer), or a named list of numeric vectors, one per layer in `x`.
#'
#' @seealso [missingCats()], [missing.cases()], [droplevels()], `vignette("GRasters", package = "fasterRaster")`
#'
#' @example man/examples/ex_GRaster_categorical.r
#'
#' @aliases missingCats
#' @rdname missingCats
#' @exportMethod missingCats
methods::setMethod(
    f = "missingCats",
    signature = c(x = "GRaster"),
    function(x, layer = 1:nlyr(x)) {
    
    layer <- .layerIndex(layer, x, recycle = TRUE)

    levs <- levels(x)

    out <- list()
    for (i in layer) {

        if (!is.factor(x)[i]) {
            out[[i]] <- numeric()
        } else {
            
            this <- .freq(x[[i]], dtype = "CELL")
            this <- this[count == 0]
            this <- this[[3L]]
            out[[i]] <- this

        } # if this layer has levels

    } # next raster
    if (length(out) == 1L) {
        out <- out[[1L]]
    } else {
        names(out) <- names(x)[layer]
    }
    out

    } # EOF
)