attic/configureOpenML.R

In openml/openml-r: Open Machine Learning and Open Data Platform

#' @title Configures the behavior of the package.
#'
#' @description
#' Configuration is done by setting custom \code{\link{options}}.
#' If you do not set an option here, its current value will be kept.
#'
#' @param show.info [\code{logical(1)}]\cr
#'   Some methods of OpenML support a \code{show.info} argument to enable
#'   verbose output on the console. This option sets the default value for these arguments.
#'   Setting the argument manually in one of these functions will overwrite the default
#'   value for that specific function call.
#'   Default is \code{TRUE}.
#' @param cache.dir [\code{character(1)}]\cr
#'   Directory to cache downloaded files. Defaults to \code{\link[base]{tempdir}}
#'  (per session cache). Set it a directory to enable a persistent cache.
#' @param cache.compression [\code{character(1)}]\cr
#'   Compression type for storing downloaded ASCII files.
#'   Possible values are \dQuote{none} (default), \dQuote{gz} (fast)
#'   and \dQuote{xz} (slow, smaller file size).
#' @return [\code{named list}] (invisibly) with updated configuration.
#' @family configure
#' @export
#' @examples
#'  # save state
#'  before = configureOpenML()
#'  configureOpenML(show.info = FALSE)
#'  # reset
#'  do.call(configureOpenML, before)
configureOpenML = function(show.info, cache.dir, cache.compression) {
  if (!missing(show.info)) {
    assertFlag(show.info)
    setOpenMLOption("show.info", show.info)
  }

  if (!missing(cache.dir)) {
    assertString(cache.dir)
    if (!isDirectory(cache.dir)) {
      if (!dir.create(cache.dir))
        stopf("Could not create cache directory '%s'", cache.dir)
    }
    setOpenMLOption("cache.dir", cache.dir)
  }

  if (!missing(cache.compression)) {
    assertChoice(cache.compression, c("none", "gz", "xz"))
    setOpenMLOption("cache.compression", cache.compression)
  }

  invisible(getOpenMLOptions())
}