R/is_python_package_installed.R

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

#' Determine if a Python package is installed
#' @inheritParams default_params_doc
#' @param package_name the Python package's name
#' @return nothing
#' @examples
#' if (plinkr::is_on_ci()) {
#'
#'   ormr_folder_name <- create_default_conda_env()
#'
#'   # setuptools is installed with the Conda environment
#'   is_python_package_installed(
#'     ormr_folder_name = ormr_folder_name,
#'     package_name = "setuptools"
#'   )
#'
#'   # scipy is not installed with the Conda environment
#'   # Use 'ormr::install_python_packages' to install scipy
#'   is_python_package_installed(
#'     ormr_folder_name = ormr_folder_name,
#'     package_name = "scipy"
#'   )
#'
#' }
#' @author Richèl J.C. Bilderbeek
#' @export
is_python_package_installed <- function(
  package_name,
  ormr_folder_name = get_default_ormr_folder_name(),
  python_version = get_default_python_version(),
  verbose = FALSE
) {
  # 'get_installed_python_packages' will check for 'python3'
  package_name %in% ormr::get_installed_python_packages(
    ormr_folder_name = ormr_folder_name,
    python_version = python_version,
    verbose = verbose
  )$package
}