R/module.R

In tgirke/systemPipeR: systemPipeR: workflow management and report generation environment

#################################################
## Class and Method Definitions for EnvModules ##
#################################################
## Define EnvModules class
setClass("EnvModules", slots = c(
    available_modules = "list",
    loaded_modules = "list",
    default_modules = "list",
    modulecmd = "character"
))

## Methods to return module components
setGeneric(name = "available_modules", def = function(x) standardGeneric("available_modules"))
setMethod(f = "available_modules", signature = "EnvModules", definition = function(x) {
    return(x@available_modules)
})
setGeneric(name = "loaded_modules", def = function(x) standardGeneric("loaded_modules"))
setMethod(f = "loaded_modules", signature = "EnvModules", definition = function(x) {
    return(x@loaded_modules)
})
setGeneric(name = "default_modules", def = function(x) standardGeneric("default_modules"))
setMethod(f = "default_modules", signature = "EnvModules", definition = function(x) {
    return(x@default_modules)
})
setGeneric(name = "modulecmd", def = function(x) standardGeneric("modulecmd"))
setMethod(f = "modulecmd", signature = "EnvModules", definition = function(x) {
    return(x@modulecmd)
})

## Constructor methods
## List to EnvModules with: as(mylist, "EnvModules")
setAs(
    from = "list", to = "EnvModules",
    def = function(from) {
        new("EnvModules",
            available_modules = from$available_modules,
            loaded_modules = from$loaded_modules,
            default_modules = from$default_modules,
            modulecmd = from$modulecmd
        )
    }
)

## Coerce back to list: as(EnvModules, "list")
setGeneric(name = "EnvModules", def = function(x) standardGeneric("EnvModules"))
setMethod(f = "EnvModules", signature = "EnvModules", definition = function(x) {
    modules <- list(
        available_modules = x@available_modules, loaded_modules = x@loaded_modules, default_modules = x@default_modules,
        modulecmd = x@modulecmd
    )
    return(modules)
})

## EnvModules to list with: as("EnvModules", list)
setAs(
    from = "EnvModules", to = "list",
    def = function(from) {
        EnvModules(from)
    }
)

## Define print behavior for EnvModules
setMethod(
    f = "show", signature = "EnvModules",
    definition = function(object) {
        if (length(object@loaded_modules) == 0) {
            name_load <- 0
        } else {
            name <- names(object@loaded_modules)
            name_load <- length(object@loaded_modules[[name]])
        }
        if (length(object@available_modules$avail) == 0) {
            s_avail <- "Run: 'moduleAvail()'"
        } else {
            s_avail <- length(object@available_modules$avail)
        }
        cat(paste0("Instance of '", class(object), "':"),
            paste0("   Slot names/accessors: "),
            paste0("      modules available: ", s_avail),
            paste0("      modules loaded: ", name_load),
            paste0("      default modules: ", length(object@default_modules$default_modules)),
            paste0("      modulecmd: '", object@modulecmd, "'"),
            "\n",
            sep = "\n"
        )
    }
)

## Extend names() method
setMethod(
    f = "names", signature = "EnvModules",
    definition = function(x) {
        return(slotNames(x))
    }
)

# Behavior of "[" operator for EnvModules
setMethod(f = "[", signature = "EnvModules", definition = function(x, i, ..., drop) {
    if (is.logical(i)) {
        i <- which(i)
    }
    x@available_modules <- x@available_modules[i]
    x@loaded_modules <- x@loaded_modules[i]
    x@default_modules <- x@default_modules[i]
    x@modulecmd <- x@modulecmd[i]
    return(x)
})

## Behavior of "[[" operator for EnvModules
setMethod(
    f = "[[", signature = c("EnvModules", "ANY", "missing"),
    definition = function(x, i, ..., drop) {
        return(as(x, "list")[[i]])
    }
)

## Behavior of "$" operator for EnvModules
setMethod("$",
    signature = "EnvModules",
    definition = function(x, name) {
        slot(x, name)
    }
)

## Replacement method for EnvModules using "[" operator
setReplaceMethod(f = "[[", signature = "EnvModules", definition = function(x, i, j, value) {
    if (i == 1) x@default_modules <- value
    if (i == 2) x@modulecmd <- value
    if (i == "default_modules") x@default_modules <- value
    if (i == "modulecmd") x@modulecmd <- value
    return(x)
})

#################################
## Module function Constructor ##
#################################
module <- function(action_type, module_name = NULL) {
    # Find path for module command
    modulecmd_path <- is.modules.avail()
    # Only initialize module system if it has not yet been initialized and the module command exists
    if (Sys.getenv("MODULEPATH") == "" && length(modulecmd_path) > 0) {
        list <- module.Clear.Init("init", modulecmd_path)
    } else if (Sys.getenv("MODULEPATH") == "" && length(modulecmd_path) == 0) {
        stop("Cound not find the path of Environment Modules command \"modulecmd\" nor LMOD_CMD")
    }
    mymodules <- list(
        available_modules = list(),
        loaded_modules = module.List.Avail("list", is.modules.avail()),
        default_modules = default_modules <- myEnvModules(),
        modulecmd = modulecmd_path <- is.modules.avail()
    )
    ## Action
    switch(action_type,
           "load"   = mymodules$loaded_modules <- module.Load.Unload(action_type, module_name, mymodules$modulecmd),
           "unload" = mymodules$loaded_modules <- module.Load.Unload(action_type, module_name, mymodules$modulecmd),
           "list"   = mymodules$loaded_modules <- print(module.List.Avail(action_type, mymodules$modulecmd)),
           "avail"  = mymodules$available_modules <- module.List.Avail(action_type, mymodules$modulecmd),
           "clear"  = mymodules$loaded_modules <- module.Clear.Init(action_type, mymodules$modulecmd),
           "init"   = mymodules$loaded_modules <- module.Clear.Init(action_type, mymodules$modulecmd),
           stop("That action is not supported.")
    )
    invisible(as(mymodules, "EnvModules"))
}
## Usage::
# mod <- module("init")
# mod <- module("list")
# mod <- module("avail")
# mod <- module("load","samtools")
# mod <- module("unload", "samtools")
# mod <- module("clear")

##############
## Wrappers ##
##############

################
## moduleInit ##
################
# Function to load default modules files
moduleInit <- function() {
    return(module("init"))
}
## Usage:
# mod <- moduleInit()

################
## modulelist ##
################
## List software available in module system
modulelist <- function() {
    return(module("list"))
}
## Usage:
# mod <- modulelist()

################
## moduleAvail ##
################
# Function to check module avail
moduleAvail <- function() {
    return(module("avail"))
}
## Usage:
# mod <- moduleAvail()

################
## moduleload ##
################
## Load software from module system
moduleload <- function(module_name) {
    return(module("load", module_name))
}
## Usage:
# mod <- moduleload("samtools")
# mod <- moduleload(c("samtools", "hisat2"))

##################
## moduleUnload ##
##################
# Unload module file
moduleUnload <- function(module_name) {
    return(module("unload", module_name))
}
## Usage:
# mod <- moduleUnload("samtools")
# mod <- moduleUnload(c("samtools", "hisat2"))

#################
## moduleClear ##
#################
# Unload all currently loaded modules
moduleClear <- function() {
    return(module("clear"))
}

## Usage:
# mod <- moduleClear()

##################################
## module accessories functions ##
#################################

######################
## is.modules.avail ##
######################
# Check if the Environment Modules is available in the system and returns module
# function PATH.
is.modules.avail <- function() {
    ## Find path for module command
    modulecmd_path <- Sys.getenv("LMOD_CMD")
    if (Sys.info()[["sysname"]] == "Windows") {
        modulecmd_path <- NULL
    } else {
        if (modulecmd_path == "") {
            try(suppressWarnings(modulecmd_path <- system("which modulecmd", intern = TRUE, ignore.stderr = TRUE)),
                silent = TRUE
            )
        }
    }
    ## "Environment Modules" is not available
    if (length(modulecmd_path) == 0) {
        message(
            "'Environment Modules is not available. Please make sure to configure
            your PATH environment variable according to the software in use.'", "\n",
            "Find more detail help('module')"
        )
        ## "Environment Modules" is available and proceed the module action_type
    } else if (length(modulecmd_path) > 0) {
        return(modulecmd_path)
    }
}

## Usage:
# is.modules.avail()

##################
## myEnvModules ##
##################
# It returns a list with all default modules files.
myEnvModules <- function() {
    # Module function assumes are using a bash SHELL
    if (!system("echo $0", intern = TRUE) %in% c("bash", "sh")) warning("'module' function assumes you are using a bash SHELL and may not work as expected in other SHELL types.")
    # Get base environment from login profile
    base_env <- strsplit(system('bash -l -c "env"', intern = TRUE, ignore.stderr = TRUE), "\n")
    base_env <- strsplit(as.character(base_env), "=")
    # Iterate through base environment
    for (x in seq_along(base_env)) {
        # Set environment based on login profile
        if (base_env[[x]][1] == "LOADEDMODULES" || base_env[[x]][1] == "MODULESHOME" || base_env[[x]][1] == "MODULEPATH" || base_env[[x]][1] == "MODULES_DIR" || base_env[[x]][1] == "HPCC_MODULES") {
            if (base_env[[x]][1] == "LOADEDMODULES") {
                default_modules <- strsplit(base_env[[x]][2], ":")
                names(default_modules) <- "default_modules"
            } else {
                l <- list(base_env[[x]][2])
                names(l) <- base_env[[x]][1]
                do.call(Sys.setenv, l)
            }
        }
    }
    return(default_modules)
}
## Usage:
# myEnvModules()

########################
## module.Load.Unload ##
########################
# Internal function to module load <module_name> and module unload <module_name>
module.Load.Unload <- function(action_type, module_name = "", modulecmd_path) {
    module_name <- paste(module_name, collapse = " ")
    # modulecmd_path <- is.modules.avail()
    # Use the low level C binary for generating module environment variables
    try(module_vars <- system(paste(modulecmd_path, "bash", action_type, module_name), intern = TRUE))
    if (length(module_vars) > 0) {
        for (y in seq(1, length(module_vars))) {
            # Separate environment variables
            module_var <- strsplit(module_vars, ";")
            # Iterate through all environment variables
            for (x in seq(1, length(module_var[[y]]))) {
                # Isolate key, value pair
                evar <- module_var[[y]][x]
                # Filter export commands
                if (length(grep("^ *export", evar)) == 0 && length(evar) > 0) {
                    # Seprate key and value
                    evar <- strsplit(as.character(evar), "=")
                    # Stip spaces at the end of the value
                    evar_val <- gsub("\\\\", "", gsub("[[:space:]]", "", evar[[1]][2]))
                    # Remove extra backslashes
                    l <- list(gsub("\\$", "", evar_val))
                    # Load dependant modules
                    if (length(grep("^ *module", evar[[1]][1])) > 0) {
                        inner_module <- strsplit(evar[[1]][1], " ")
                    }
                    # Source environment
                    else if (length(grep("^ *source", evar[[1]][1])) > 0) {
                        warning("Module uses a bash script to initialize, some software may not function as expected:\n\t", evar[[1]][1])
                    }
                    # Unset variables that need to be unset
                    else if (length(grep("^ *unset ", evar[[1]][1])) > 0) {
                        evar <- gsub("^unset (.*)$", "\\1", evar[[1]][1])
                        Sys.unsetenv(evar)
                    } else {
                        # Assign names to each value in list
                        names(l) <- evar[[1]][1]
                        # Set environment variable in current environment
                        do.call(Sys.setenv, l)
                    }
                }
            }
        }
    }
    module_loaded <- module.List.Avail("list", modulecmd_path)
    return(module_loaded)
}

## Usage:
# module.Load.Unload("load", "samtools")
# module.Load.Unload("unload", "samtools")

########################
## module.List.Avail ##
########################
# Internal function to module list and module avail
module.List.Avail <- function(action_type, modulecmd_path) {
    try(module_vars <- system2(modulecmd_path, paste("bash", action_type, "-t"), stdout = TRUE, stderr = TRUE))
    ## Return only the module names
    module_l <- module_vars[-grep(":$", module_vars)]
    for (i in seq_along(module_l)) {
        if (grepl("\033\\[0m", module_l[i])) {
            module_l[i] <- gsub("*\033\\[0m", "", module_l[i])
            module_l[i] <- gsub("\033\\[4m", "", module_l[i])
            module_l[i] <- gsub("\033\\[4;90;47", "", module_l[i])
            module_l[i] <- gsub("\033\\[90;47", "", module_l[i])
        }
    }
    module_l <- list(module_l)
    names(module_l) <- action_type
    return(module_l)
}

## Usage:
# module.List.Avail("list")
# module.List.Avail("avail")

########################
## module.Clear.Init ##
########################
# Internal function to module clear and module init
module.Clear.Init <- function(action_type, modulecmd_path) {
    if (action_type == "init") {
        default_modules <- myEnvModules()
        ## Make sure to process default modules after the environment is set with the above loop
        for (x in seq_along(default_modules[[1]])) {
            print(paste("Loading module", default_modules[[1]][x]))
            try(module.Load.Unload("load", default_modules[[1]][x], modulecmd_path))
        }
        return(default_modules)
    } else if (action_type == "clear") {
        loaded_modules <- strsplit(Sys.getenv("LOADEDMODULES"), ":")
        if (length(loaded_modules[[1]]) > 0) {
            for (x in seq(1, length(loaded_modules[[1]]))) {
                module_name <- loaded_modules[[1]][x]
                print(paste("Unloading module", module_name))
                try(module.Load.Unload("unload", module_name, modulecmd_path))
            }
        }
        return(list())
    }
}

## Usage:
# module.Clear.Init("init", modulecmd_path)
# module.Clear.Init("clear")

#########################################
## .callModNew function Constructor ##
#########################################
## This was developed for the r shell in Module system.
# .callModNew <- function(action_type, module_name, modulecmd_path) {
#     if (action_type %in% c("list", "clear", "init") && !is.null(module_name)) {
#         warning("Any value of `module_name` for action type 'list', 'clear', and 'init' is ignored", immediate. = TRUE)
#     }
#     if (action_type %in% c("load", "unload") && is.null(module_name)) {
#         stop("`module_name` cannot be empty for load and unload actions")
#     }
#     
#     cmdpipe <- pipe(paste0(modulecmd_path, " r autoinit"))
#     on.exit(try(close(cmdpipe), silent = TRUE), add = TRUE)
#     myenv <- new.env()
#     eval(parse(cmdpipe), envir = myenv)
#     
#     module_name <- paste(module_name, collapse = " ")
#     if (action_type %in% c("init")) {
#         default_modules <- myEnvModules()[[1]]
#         module_name <- paste(default_modules, collapse = " ")
#     }
#     call_cmd <- switch(action_type,
#                        "load"   = paste("load", module_name),
#                        "unload" = paste("unload", module_name),
#                        "init"   = paste("load", module_name),
#                        "list"   = "list",
#                        "avail"  = paste("avail", module_name),
#                        "clear"  = "clear -f",
#                        stop("That action is not supported.")
#     )
#     call_cmd <- stringr::str_remove(call_cmd, "[ ]{0,}$")
#     eval(parse(text = paste0("myenv$module(", deparse(call_cmd), ")")))
# }