add conda to ci; clean up public API

Author: rpreen

.github/workflows/R-CMD-check.yaml

@@ -3,43 +3,67 @@ on:
     branches: [main, master]
   pull_request:
     branches: [main, master]
+
 name: R-CMD-check
+
 jobs:
   R-CMD-check:
     runs-on: ${{ matrix.os }}
-    name: ${{ matrix.os }} (${{ matrix.r }})
+    name: ${{ matrix.os }} (${{ matrix.r }}) - ${{ matrix.backend }}
+
     strategy:
       fail-fast: false
       matrix:
         include:
-          - { os: "ubuntu-latest", python: "3.13", r: "release" }
-          - { os: "windows-latest", python: "3.13", r: "release" }
-          - { os: "macOS-latest", python: "3.13", r: "release" }
-          - { os: "ubuntu-latest", python: "3.10", r: "oldrel-1" }
-          - { os: "ubuntu-latest", python: "3.10", r: "oldrel-2" }
-          - { os: "ubuntu-latest", python: "3.10", r: "oldrel-3" }
+          - { os: "ubuntu-latest", python: "3.13", r: "release", backend: "venv" }
+          - { os: "ubuntu-latest", python: "3.13", r: "release", backend: "conda" }
+
+          - { os: "windows-latest", python: "3.13", r: "release", backend: "venv" }
+          - { os: "windows-latest", python: "3.13", r: "release", backend: "conda" }
+
+          - { os: "macOS-latest", python: "3.13", r: "release", backend: "venv" }
+          - { os: "macOS-latest", python: "3.13", r: "release", backend: "conda" }
+
+          - { os: "ubuntu-latest", python: "3.10", r: "oldrel-1", backend: "venv" }
+          - { os: "ubuntu-latest", python: "3.10", r: "oldrel-2", backend: "venv" }
+          - { os: "ubuntu-latest", python: "3.10", r: "oldrel-3", backend: "venv" }
+
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
       R_KEEP_PKG_SOURCE: yes
       MPLBACKEND: Agg
+      ACRO_USE_CONDA: ${{ matrix.python_backend == 'conda' && 'true' || 'false' }}
+
     steps:
       - name: Checkout ACRO
         uses: actions/checkout@v4
+
+      - name: Setup Miniconda
+        if: matrix.backend == 'conda'
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          python-version: ${{ matrix.python }}
+          auto-activate-base: false
+
       - name: Setup Python
         uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python }}
+
       - name: Setup pandoc
         uses: r-lib/actions/setup-pandoc@v2
+
       - name: Setup R
         uses: r-lib/actions/setup-r@v2
         with:
           r-version: ${{ matrix.r }}
+
       - name: Install R dependencies
         uses: r-lib/actions/setup-r-dependencies@v2
         with:
           extra-packages: any::rcmdcheck
           needs: check
+
       - name: Check R Package
         uses: r-lib/actions/check-r-package@v2
         with:

R/acro_init.R

@@ -4,9 +4,7 @@ acro_pkg <- "acro==0.4.11"
 ch <- "conda-forge"
 
 
-#' Resolve Python executable
-#'
-#' @return String path to a Python executable.
+# Internal helper: resolve Python executable
 ## nocov start
 get_python <- function() {
   python <- Sys.which("python3")
@@ -21,9 +19,7 @@ get_python <- function() {
 ## nocov end
 
 
-#' Install ACRO in a conda environment
-#'
-#' @param envname Name of the conda environment
+# Internal helper: install ACRO in a Conda environment
 ## nocov start
 install_conda <- function(envname) { # nocov
   if (!reticulate::condaenv_exists(envname = envname, conda = "auto")) {
@@ -34,9 +30,7 @@ install_conda <- function(envname) { # nocov
 ## nocov end
 
 
-#' Initialise ACRO in a Python virtual environment
-#'
-#' @param envname Name of the virtual environment
+# Internal helper: install ACRO in a Python virtual environment
 install_venv <- function(envname = acro_venv) {
   if (!reticulate::virtualenv_exists(envname)) {
     python <- get_python()
@@ -53,15 +47,35 @@ install_venv <- function(envname = acro_venv) {
 }
 
 
+# Internal helper: resolve whether Conda should be used
+get_use_conda <- function(use_conda = NULL) {
+  if (is.null(use_conda)) {
+    use_conda <- tolower(Sys.getenv("ACRO_USE_CONDA")) %in% c("1", "true", "yes")
+  }
+  use_conda <- isTRUE(use_conda) # default FALSE
+
+  if (use_conda && !reticulate::miniconda_exists()) { # nocov
+    stop("Conda requested but no Miniconda installation found", call. = FALSE) # nocov
+  }
+
+  return(use_conda)
+}
+
+
 #' Initialise an ACRO object
 #'
 #' @param suppress Whether to automatically apply suppression.
 #' @param envname Name of the Python environment to use.
-#' @param use_conda Whether to use a Conda environment (`TRUE`) or venv (`FALSE`).
+#' @param use_conda Whether to use a Conda environment.
+#'   If `NULL`, looks for environment variable `ACRO_USE_CONDA`,
+#'   defaults to `FALSE` if unset.
 #'
 #' @return Invisibly returns the ACRO object, which is used internally.
 #' @export
-acro_init <- function(suppress = FALSE, envname = acro_venv, use_conda = FALSE) {
+acro_init <- function(suppress = FALSE, envname = acro_venv, use_conda = NULL) {
+  # define the environment
+  use_conda <- get_use_conda(use_conda)
+
   # initialise the environment
   if (!reticulate::py_available(initialize = FALSE)) {
     if (use_conda) { # nocov