AI-SDC
diff --git a/‎.Rbuildignore‎
Lines changed: 11 additions & 0 deletions b/‎.Rbuildignore‎
Lines changed: 11 additions & 0 deletions
diff --git a/‎.github/workflows/R-CMD-check.yaml‎
Lines changed: 8 additions & 28 deletions b/‎.github/workflows/R-CMD-check.yaml‎
Lines changed: 8 additions & 28 deletions
diff --git a/‎.github/workflows/pkgdown.yaml‎
Lines changed: 0 additions & 6 deletions b/‎.github/workflows/pkgdown.yaml‎
Lines changed: 0 additions & 6 deletions
diff --git a/‎.gitignore‎
Lines changed: 3 additions & 0 deletions b/‎.gitignore‎
Lines changed: 3 additions & 0 deletions
diff --git a/‎.pre-commit-config.yaml‎
Lines changed: 2 additions & 1 deletion b/‎.pre-commit-config.yaml‎
Lines changed: 2 additions & 1 deletion
diff --git a/‎DESCRIPTION‎
Lines changed: 4 additions & 1 deletion b/‎DESCRIPTION‎
Lines changed: 4 additions & 1 deletion
diff --git a/‎R/create_virtualenv.R‎
Lines changed: 20 additions & 6 deletions b/‎R/create_virtualenv.R‎
Lines changed: 20 additions & 6 deletions
diff --git a/‎_pkgdown.yml‎
Lines changed: 25 additions & 3 deletions b/‎_pkgdown.yml‎
Lines changed: 25 additions & 3 deletions
diff --git a/‎inst/WORDLIST‎
Lines changed: 13 additions & 0 deletions b/‎inst/WORDLIST‎
Lines changed: 13 additions & 0 deletions
diff --git a/‎inst/examples.md‎
Lines changed: 40 additions & 0 deletions b/‎inst/examples.md‎
Lines changed: 40 additions & 0 deletions
@@ -15,3 +15,14 @@
 ^data/nursery\.arff$
 ^data/charity\.dta$
 ^prepare_to_submit_to_CRAN\.R$
+^pkgdown$
+^index\.md$
+^examples\.md$
+^installation\.md$
+^supports\.md$
+^welcome\.md$
+^\.vscode$
+^.*\.swp$
+^\.Rdata$
+^doc$
+^Meta$
@@ -1,65 +1,45 @@
-# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
-# Need help debugging build failures?
-# Start at https://github.com/r-lib/actions#where-to-find-help
 on:
   push:
     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 }})
-
     strategy:
       fail-fast: false
       matrix:
         include:
-
-          # default everything
-          - {os: 'ubuntu-latest', python: '3.13', r: 'release'}
-          - {os: 'windows-latest', python: '3.13', r: 'release'}
-          - {os: 'macOS-latest', python: '3.13', r: 'release'}
-
-          # older R versions
-          - {os: 'ubuntu-latest', python: '3.9', r: 'oldrel-1'}
-          - {os: 'ubuntu-latest', python: '3.9', r: 'oldrel-2'}
-          - {os: 'ubuntu-latest', python: '3.9', r: 'oldrel-3'}
-
+          - { 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" }
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
       R_KEEP_PKG_SOURCE: yes
-      # set matplotlib backend because Windows CI errors with:
-      # "This probably means that Tcl wasn't installed properly."
-      MPLBACKEND: Agg  # https://github.com/orgs/community/discussions/26434
-
+      MPLBACKEND: Agg
     steps:
       - name: Checkout ACRO
-        uses: actions/checkout@v5
-
+        uses: actions/checkout@v4
       - 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:
 
@@ -14,12 +14,6 @@ jobs:
   pkgdown:
     runs-on: ubuntu-latest
 
-    concurrency:  # restrict concurrency for non-PR jobs
-      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
-
-    env:
-      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
-
     steps:
       - name: Checkout
         uses: actions/checkout@v5
 
@@ -148,3 +148,6 @@ stata/various_stata_development__files
 # test output
 /outputs/
 /test.xlsx
+inst/doc
+/doc/
+/Meta/
@@ -34,7 +34,8 @@ repos:
           (?x)^(
             .*\.txt|
             .*\.ipynb|
-            .*\.html
+            .*\.html|
+            docs/deps/.*
           )$
 
   # Format R files
 
@@ -13,7 +13,7 @@ Description: A Tool for Semi-Automating the Statistical Disclosure Control of Re
 License: MIT + file LICENSE
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.2
+RoxygenNote: 7.3.3
 SystemRequirements: Python (>= 3.10)
 Imports:
     reticulate,
@@ -23,9 +23,12 @@ Depends:
     R (>= 2.10)
 LazyData: true
 Suggests:
+    knitr,
+    rmarkdown,
     spelling,
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
 Language: en-US
 URL: https://github.com/AI-SDC/ACRO-R
 BugReports: https://github.com/AI-SDC/ACRO-R/issues
+VignetteBuilder: knitr
@@ -2,20 +2,29 @@ acro_venv <- "r-acro"
 acro_package <- "acro==0.4.11"
 python_version <- ">=3.10"
 
-
 #' Install acro
 #'
 #' @param envname the name of the Python virtual environment
+#' @param python the path to Python executable
 #' @param ... Any other parameters.
 #'
 #' @return No return value, called for side effects
+install_acro <- function(envname = "r-acro", python = NULL, ...) {
+  # Get Python executable if not provided
+  if (is.null(python)) {
+    python <- Sys.which("python3")
+    if (python == "") {
+      python <- Sys.which("python") # nocov
+      if (python == "") { # nocov
+        stop("Python not found in PATH. Please ensure Python is installed and accessible.") # nocov
+      } # nocov
+    }
+  }
 
-
-install_acro <- function(envname = "r-acro", ...) {
   # create Python virtual environment
   reticulate::virtualenv_create(
     envname = envname,
-    version = python_version,
+    python = python,
     force = TRUE,
     packages = NULL
   )
@@ -29,11 +38,16 @@ install_acro <- function(envname = "r-acro", ...) {
 #' @param ... Any other parameters.
 #'
 #' @return No return value, called for side effects
-
 create_virtualenv <- function(...) {
+  # Get Python executable path
+  python_path <- Sys.which("python3")
+  if (python_path == "") {
+    python_path <- Sys.which("python") # nocov
+  }
+
   # ensure a virtual environment exists
   if (!reticulate::virtualenv_exists(acro_venv)) {
-    install_acro(envname = acro_venv)
+    install_acro(envname = acro_venv, python = python_path)
   }
 
   # activate virtual environment
 
@@ -1,5 +1,27 @@
----
-url: https://AI-SDC.github.io/ACRO-R/
 template:
+  light-switch: true
   bootstrap: 5
-...
+  bslib:
+    primary: "#0051a5"
+
+navbar:
+  structure:
+    left: [home, reference, welcome, supports, installation, examples]
+    right: [search, github, lightswitch]
+  left:
+  - text: "Home"
+    href: index.html
+  - text: "Reference"
+    href: reference/index.html
+  - text: "Welcome to ACRO-R"
+    href: welcome.html
+  - text: "What ACRO-R Supports"
+    href: supports.html
+  - text: "Installation"
+    href: installation.html
+  - text: "Examples"
+    href: examples.html
+  right:
+  - icon: fab-github
+    href: https://github.com/AI-SDC/ACRO-R
+    aria-label: GitHub
@@ -2,27 +2,40 @@ ADR
 Acknowledgement
 Analytics
 EPSRC
+GPLv
 GRAIMATTER
 HDR
 Initialise
 Karnofsky
 MRC
 MyBinder
+NK
+PyPI
 RStudio
 SACRO
 SDC
+Scalable
+TRE
 Xplore
 auditable
+btn
 codecov
+crosstab
 disclosive
+finalise
 github
 https
 initialised
 json
+mitigations
 numpy
 openml
+organisation
 pre
 programme
+sacro
 scipy
+sm
+statsmodels
 www
 xlsx
@@ -0,0 +1,40 @@
+# Examples
+
+## Interactive Notebook
+
+For comprehensive examples and tutorials, see our interactive R notebook:
+
+[Example Notebook](articles/example-notebook.html)
+
+## Quick Start Examples
+
+### Basic Usage
+
+```r
+library("acro")
+
+# Initialize ACRO
+acro_init(suppress = TRUE)
+
+# Your analysis code here
+# ACRO will automatically check outputs for disclosure risks
+```
+
+### Creating Safe Tables
+
+```r
+# Example of creating a cross-tabulation with ACRO
+result <- acro_crosstab(data$variable1, data$variable2)
+
+# ACRO automatically applies disclosure control
+print(result)
+```
+
+### Finalizing Your Session
+
+```r
+# When you're done with your analysis
+acro_finalise()
+```
+
+For more detailed examples and use cases, please refer to the [Example Notebook](articles/example-notebook.html).