R/pkgSetting.R

In Jiefei-Wang/AltWrapper: Create an ALTREP object by defining ALTREP functions in R

globalSettings <- new.env()
globalSettings$redefineWarning <- TRUE
globalSettings$chunkSize <- 512L
#' AltWrapper Options Settings
#'
#' Get and set the package settings
#'
#' @param ... a list of named arguments to change the package settings,
#'  or a vector of character names to get the package settings. See details for
#'  the available settings
#'  
#'  @details 
#'  `redefineWarning`: controls whether an warning will be given 
#'  when users try to redine a function or a class of an AltWrapper class.
#'  
#'  `chunkSize`: The batch size that will be used to temporary stores values for a vector.
#'  It is used for the S3/S4 altWrapper `print` function when the data pointer of the vector
#'  is not available.
#'
#' @examples
#' ## Get the default package settings
#' getAltWrapperOptions("redefineWarning")
#' ## change the settings
#' setAltWrapperOptions(redefineWarning = FALSE)
#' ## Get the settings again to see the change
#' getAltWrapperOptions("redefineWarning")
#'
#' @return 
#' `setAltWrapperOptions`: No return value 
#' `getAltWrapperOptions`: A list of package settings
#' @rdname AltWrapperOption
#' @export
setAltWrapperOptions <- function(...) {
    options <- list(...)
    options <- checkOptionExistance(options)
    for (i in seq_along(options)) {
        globalSettings[[names(options)[i]]] <- options[[i]]
    }
}
#' @rdname AltWrapperOption
#' @export
getAltWrapperOptions <- function(...) {
    options = c(...)
    if (length(options) == 0) {
        return(as.list(globalSettings))
    }
    res = as.list(globalSettings)[options]
    if (length(options) == 1) {
        return(res[[1]])
    }
    return(res)
}

## Check if options exist or not
## return the options that exist
checkOptionExistance <- function(options) {
    noneExistOptions = !names(options) %in% names(globalSettings)
    if (any(noneExistOptions)) {
        vapply(paste0(names(options)[noneExistOptions]), function(x)
            warning("The option `", x, "` does not exist"), character(1))
    }
    options <- options[!noneExistOptions]
    return(options)
}