R/settings.R

In KopfLab/isoprocessorCUB: IRMS data processor

#' @export
isoreader::iso_turn_info_messages_on

#' @export
isoreader::iso_turn_info_messages_off

# default parameters =====

# retrieve package settings, internal function, not exported
# first checks if the setting exists in the isoreader space, then in the isoprocessor
# @note: consider providing an option that indicates whether to return the expression or a default value
# e.g. default(x) that returns expr(x) if x is not set vs. default(x, NULL) that returns expr(NULL) if x is not set
# @CONSIDER: alternatively set ALL available parameters in the initialize_options and force parameters to exist
default <- function(name) {
  name_exp <- rlang::enexpr(name)
  value <- isoreader:::default(!!name_exp, allow_null = TRUE)
  if (is.null(value)) { # not in isoreader settings
    name <- if (rlang::is_symbol(name_exp)) rlang::as_name(name_exp) else name_exp
    value <- getOption(str_c("isoprocessor.", name))
  }
  if (is.null(value)) { # not in normal isoprocessor settings
    func_params <- get_process_parameters()
    if (name %in% names(func_params))
      value <- func_params[[name]]
    else
      value <- name_exp
  }
  return(value)
}

# set package setting, internal function, not exported
# @note essetially same function as in isoreader except with the isoprocessor. prefix
set_default <- function(name, value, overwrite = TRUE) {
  if (overwrite || !str_c("isoprocessor.", name) %in% names(options()))
    options(list(value) %>% setNames(str_c("isoprocessor.", name)))
  return(invisible(value))
}

# processing default parameters =====

# get the default parameters
get_process_parameters <- function() {
  default("default_parameters")
}

#' Set default parameters
#' Define the default parameters for calculations used in this package.
#' @param data can be used to include this function call within a pipeline
#' @param ... named entries for the default parameters (standard or non-standard evaluation supported).
#' @return invisibly returns the passed in \code{data} object
#' Names are equivalent to function parameter names and
#' @family settings functions
#' @export
iso_set_default_processor_parameters <- function(data = NULL, ...) {
  def_cols <- quos(...)
  existing_def_cols <- get_process_parameters()
  set_default("default_parameters", modifyList(existing_def_cols, def_cols))
  return(invisible(data))
}

#' @details \code{iso_reset_default_processor_parameters} resets all default function parameters for this package.
#' @rdname iso_set_default_processor_parameters
#' @export
iso_reset_default_processor_parameters <- function(data = NULL) {
  initialize_options()
  return(invisible(data))
}

#' Get the current default processor parameters
#'
#' Retrieve a table with all default parameters for the isoprocessor package
#' (see \link[isoreader]{iso_get_default_reader_parameters} for the equivalent isoreader function).
#' To set processor parameters, see \code{\link{iso_set_default_processor_parameters}}.
#' To set messaging and caching parameters see \code{\link[isoreader]{iso_info_messages}}.
#' For a piping compatible version of this function, see \link{iso_show_default_processor_parameters}.
#' @family settings functions
#' @export
iso_get_default_processor_parameters <- function() {
  regular_params <- tibble(parameter = "quiet", value = as.character(default("quiet")))
  func_params <- get_process_parameters()
  if (length(func_params) > 0) {
    bind_rows(
      regular_params,
      tibble(parameter = names(func_params), value = map_chr(func_params, as_label) %>% unname())
    ) %>% return()
  } else
    return(regular_params)
}

#' Show the current default processor parameters
#'
#' Shows a table with the default function parameters for this package.
#' @inheritParams iso_set_default_processor_parameters
#' @param func function to use for formatting the reader parameters table, e.g. \code{\link[knitr]{kable}}.
#' Note that if the output is in RMarkdown chunks, the chunk option must have \code{results="asis"} for the table to be correctly formatted.
#' @param ... additional parameters to forward to the \code{func} function
#' @param quiet whether to display (quiet=FALSE) or silence (quiet = TRUE) information messages.
#' @family settings functions
#' @export
#' @note DEPRECATE
iso_show_default_processor_parameters <- function(data = NULL, print_func = default(print_func), ..., quiet = default(quiet)) {

  stop("iso_show_default_processor_parameters is deprecated because of confusing behaviour. Please output the default processor parameters using iso_get_default_processor_parameters().", call. = FALSE)

}