R/parameter_object.R

In MansMeg/PerspectiveTopicModel: Samples a perspetice topic model

#' Constructor for parameter object
#'
#' @param x NULL or a list with priors to set
#' @param K The number of topics.
#' @param start_iter Start iteration number.
#' @param gibbs_iter The number of Gibbs iterations
#' @param log_marginal_posterior_every Store the state file every X iteration.
#' @param save_state_every Store the state file, priors, parameters and log marginal posterior every X iteration.
#' @param state_path Where to store the state file.
#' @param seed The seed to use for the random draws
#' @param verbose Should the sampler be verbose?
#'
#' @return A \code{parameter} object
#'
#' @export
parameters <- function(x = NULL,
                       K = 10,
                       start_iter = 1L,
                       gibbs_iter = 10L,
                       log_marginal_posterior_every = 1L,
                       save_state_every = NULL,
                       state_path = "perspective_",
                       seed = as.integer(Sys.time()),
                       verbose = TRUE){
  if(!is.null(x)) {
    checkmate::assert_class(x, "list")
    checkmate::assert_subset(names(x), c("K", "start_iter", "gibbs_iter", "save_state_every", "state_path", "seed", "verbose", "log_marginal_posterior_every"))
  }

  params_obj <- list(K = K,
                    start_iter = start_iter,
                    gibbs_iter = gibbs_iter,
                    log_marginal_posterior_every = log_marginal_posterior_every,
                    save_state_every = save_state_every,
                    state_path = state_path,
                    seed = seed,
                    verbose = verbose)

  if(!is.null(x)){
    for(name in names(x)){
      params_obj[[name]] <- x[[name]]
    }
  }

  # Assertions
  checkmate::assert_integerish(params_obj$K, lower = 2L)
  checkmate::assert_integerish(params_obj$gibbs_iter, lower = params_obj$start_iter)
  checkmate::assert_integerish(params_obj$log_marginal_posterior_every, lower = 1L)
  checkmate::assert_integerish(params_obj$start_iter, lower = 1L, upper = params_obj$gibbs_iter)
  checkmate::assert_integerish(params_obj$save_state_every, lower = 1L, params_obj$gibbs_iter, null.ok = TRUE)
  checkmate::assert_path_for_output(params_obj$state_path)
  checkmate::assert_integerish(params_obj$seed, lower = 1L)
  checkmate::assert_flag(params_obj$verbose)

  # Warnings
  if(is.null(params_obj$save_state_every) & state_path != "perspective_"){
    warning("Parameter state_path is ignored.")
  }

  class(params_obj) <- c("parameters", "list")

  params_obj
}