R/py_setup.R

In DeepLearningCausal: Causal Inference with Super Learner and Deep Neural Networks

#' Check for Python module availability and install if missing.
#'
#' Call this to manually set up Python and dependencies. The function checks if Python is available via the `reticulate` package, and if not, it creates a virtual environment and installs the specified Python modules.
#' @param modules Character vector of Python modules to check for and install if missing.
#' @param envname Name of the virtual environment to use or create. Defaults to "r-reticulate".
#' @return Invisibly returns TRUE if setup is complete.
#' @examples
#' \dontrun{
#' python_ready(modules = c("keras", "tensorflow", "numpy"),
#'             envname = "r-reticulate")
#' }
#' @export
python_ready <- function(modules = c("keras", "tensorflow", "numpy"),
                         envname = "r-reticulate") {
  if (!requireNamespace("reticulate", quietly = TRUE)) {
    stop("'reticulate' package required. Please install with install.packages('reticulate').")
  }

  if (reticulate::py_available(initialize = FALSE)) {
    message("Python is already available")
  } else {
    message("Python is not available. Initializing...")
    reticulate::virtualenv_create(envname)
    reticulate::use_virtualenv(envname, required = TRUE)
  }
  message("Checking for required Python modules...")
  missing <- modules[!vapply(modules, 
                             reticulate::py_module_available, 
                             logical(1))]
  if (length(missing) > 0) {
    message("Installing missing Python modules: ", 
            paste(missing, collapse = ", "))
    reticulate::py_install(missing, envname = envname, pip = TRUE)
  } else {
    message("All required Python modules are available.")
}
  invisible(TRUE)
}

#' Check for required CRAN packages and prompt installation if missing.
#' @return Invisibly returns TRUE if all required packages are installed.
#' @keywords internal
check_cran_deps <- function() {
  packages <- c("reticulate", "keras3", "tensorflow")
  missing <- packages[!vapply(packages, requireNamespace, logical(1), quietly = TRUE)]
  if (length(missing) > 0) {
    stop("Missing required R packages: ", paste(missing, collapse = ", "),
         ". Please install them with:\ninstall.packages(c(\"", 
         paste(missing, collapse = "\", \""), "\"))")
  }
  invisible(TRUE)
}

#' Check for required Python modules and prompt installation if missing.
#' @return Invisibly returns TRUE if all required modules are available.
#' @keywords internal
check_python_modules <- function() {
  py_modules <- c("tensorflow", "keras", "numpy")
  missing <- py_modules[!vapply(py_modules, reticulate::py_module_available, logical(1))]
  if (length(missing) > 0) {
    stop("Missing required Python modules: ", 
         paste(missing, collapse = ", "),
         ". Please install them in your Python environment with reticulate::py_install() or setup using python_ready().")
  }
  invisible(TRUE)
}