R/zzz.r

Defines functions .onAttach .onLoad

Documented in .onAttach .onLoad

#' Select the queueing system on package loading
#'
#' This is done by setting the variable 'qsys' in the package environment
#' to the object that contains the desired queueing system.
#'
#' @param libname  default arg for compatibility
#' @param pkgname  default arg for compatibility
#' @keywords internal
.onLoad = function(libname, pkgname) {
    qsys_default = toupper(getOption('clustermq.scheduler'))

    if (length(qsys_default) == 0) {
        qname = c("SLURM", "LSF", "SGE", "LOCAL")
        exec = Sys.which(c("sbatch", "bsub", "qsub"))
        select = c(which(nchar(exec) > 0), 4)[1]
        qsys_default = qname[select]
    }

    assign("qsys_default", qsys_default, envir=parent.env(environment()))
}

#' Report queueing system on package attach if not set
#'
#' @param libname  default arg for compatibility
#' @param pkgname  default arg for compatibility
#' @keywords internal
.onAttach = function(libname, pkgname) {
    if (is.null(getOption("clustermq.scheduler"))) {
        packageStartupMessage("* Option 'clustermq.scheduler' not set, ",
                "defaulting to ", sQuote(qsys_default))
        packageStartupMessage("--- see: https://mschubert.github.io/clustermq/articles/userguide.html#configuration")
    }
    if (!libzmq_has_draft()) {
        packageStartupMessage("* Worker disconnect monitor is disabled")
        packageStartupMessage("--- see: https://mschubert.github.io/clustermq/articles/userguide.html#installation")
    }
}
mschubert/clustermq documentation built on April 9, 2024, 3:21 a.m.