R/run_python_script.R

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

#' Run a Python script
#' @inheritParams default_params_doc
#' @return The output of the Python script
#' @seealso use \link{run_python_script_with_args} to run a Python
#' script with command-line arguments
#' @examples
#' if (plinkr::is_on_ci()) {
#'   if (is_conda_installed()) {
#'     # Use conda
#'     ormr_folder_name <- create_default_conda_env()
#'   } else {
#'     # Use local python
#'     ormr_folder_name <- "python3"
#'   }
#'
#'   python_script_path <- system.file(
#'     "extdata", "hello_world.py", package = "ormr"
#'   )
#'   run_python_script(
#'     ormr_folder_name = ormr_folder_name,
#'     python_script_path = python_script_path
#'   )
#' }
#' @author Richèl J.C. Bilderbeek
#' @export
run_python_script <- function(
  python_script_path,
  ormr_folder_name = get_default_ormr_folder_name(),
  python_version = get_default_python_version(),
  verbose = FALSE
) {
  if (ormr_folder_name == "python3") {
    # Do not use conda
    output <- system2(
      command = "python3",
      args = python_script_path,
      stdout = TRUE,
      stderr = TRUE
    )
  } else {
    # Use conda
    ormr::create_and_activate_conda_env(
      ormr_folder_name = ormr_folder_name,
      python_version = python_version,
      verbose = verbose
    )
    output <- reticulate::py_capture_output(
      reticulate::py_run_file(
        file = python_script_path
      )
    )
  }
  output
}