R/create_conda_env.R

In richelbilderbeek/ormr: Work With Python Installed At A Custom Location

#' Create a Conda environment if needed.
#'
#' Create a Conda environment if needed.
#' If that environment already exists, nothing happens.
#' @inheritParams default_params_doc
#' @param python_version the Python version,
#' which is 3.6 by default
#' (thanks to \url{https://stackoverflow.com/a/69978354}),
#' as `ormr` is a sub-package
#' for `gcaer`, where the latter needs to install the Python
#' `tensorflow` package. For more recent Python versions, this
#' install fails.
#'
#' @return Nothing
#' @note the output of this function cannot be silenced, thanks
#' to \link[reticulate]{install_miniconda}
#' @examples
#' if (is_conda_installed()) {
#'   # Install to a temporary folder
#'   ormr_folder_name <- tempfile()
#'   create_conda_env(ormr_folder_name = ormr_folder_name)
#'
#'   # Clean up
#'   unlink(ormr_folder_name, recursive = TRUE)
#' }
#' @author Richèl J.C. Bilderbeek
#' @export
create_conda_env <- function(
  ormr_folder_name = get_default_ormr_folder_name(),
  python_version = get_default_python_version(),
  verbose = FALSE
) {
  if (ormr::does_conda_env_exists(
    ormr_folder_name = ormr_folder_name,
    verbose = verbose)
  ) {
    if (verbose) {
      message("Conda environment is already created at ", ormr_folder_name)
    }
    return(invisible(ormr_folder_name))
  }
  if (verbose) {
    message(
      "Creating a new Conda environment at ", ormr_folder_name,
      " with Python version ", python_version
    )
  }
  reticulate::conda_create(
    envname = ormr_folder_name,
    python_version = python_version
  )
  invisible(ormr_folder_name)
}